iso27diy-corp/Corpus/_Corpus-metadata.md

4.5 KiB

Corpus Metadata

  • All notes in this Obsidian vault need metadata.
  • These metadata need to follow the Obsidian Front Matter Syntax.
  • Obsidian calls metadata key-value pairs 'Properties'
  • In this Corpus we use General properties (every note should have them) and Specific properties (depending on the kind of note, can be inferred from other properties)

General metadata

Notetype

The notetype field will have one of the following values:

  • guide: guided, hands-on lessons, learning by doing, interactive lessons
  • explanation: background and context to the standards, paraphrases of the original standard texts, opinion, discussion, underlying principles, interpretation
  • application: steps to solve a specific, real-world problem. Implementing the standard in real world environments, implementation aids, implementation examples, templates, etc.
  • reference: for original standard texts, dictionaries, terms and definitions.
  • other: for all notes that, by there content, cannot be placed in one for the previous categories.

Note:

  • Notes in the iso27DIY-gis/guide folder and subfolders are typically of the guide type.
  • Notes in iso27DIY-gis/reference and subfolders are typically of the explanation or application type.

Language

For the language property we use the language code as defined in ISO 639-1.

Metadata for ISO 27001 and 27002 Original Standard Texts

  • The original texts of the ISO 27001 and ISO 27002 standards can be found in the OST folder and subfolders.
  • These notes are tagged with “sourcetext”.
  • The body of these notes must never be changed!
  • Specific properties for ISO 27002 OST notes are deduced from chapter 4 of the standard ("Themes and Attributes"). They are: theme, control_type, information_security_properties, cybersecurity_concepts, operational_capabilities, and security_domains.
  • For the possible values of these properties, see ISO 27002 Themes and Attributes.

Phases for ISMS implementation

Enrichment Prompt Examples

Adding front matter to original ISO clauses and controls

  • We are going to add front matter to the files in folder iso27diy-corp/Corpus/Standards/ISO27x/OST/27002/EN.
  • To do this, you will need access to this folder and its contents. Check that you have access, and if not, stop the process immediately and get into contact with the user to fix the problem.
  • You also need to be able to read the Original Standard Text. If you cannot access or read this document, stop the process immediately and get into contact with the user to fix the problem.
  • See _Corpus-metadata for instructions on adding metadata.
  • Each note in this folder (with a few exceptions) represents an ISO 27002 Control.
  • Additionally to what is described in the Corpus Metadata note, each control will get metadata fields according to ISO 27002 Themes and Attributes - note can be found in the Content Factory folder.

Additionally, you will add the following metadata key-value pairs:

notetype: sourcetext
standard: ISO 27002
version: 2022
language: EN
type: control
id: A.<x.yy>
title: <control title>
  • The <x.yy> part of the id and the <control title> can often be found in the content of the markdown note as a level 2 header.
  • THIS IS MOST IMPORTANT: Do not make up or infer any of these themes, attributes and values. If you cannot extract them from the note itself, refer to the Original Standard Text.
  • When you cannot extract the information from the note itself, or from the Original Standard Text, mark the note with the tag REVIEW.

Adding more front matter

We are now going to work on files in iso27diy-corp/Corpus/Standards/ISO27x/OST/27001/NL/

Write a simple program or script to add properly formatted YAML front matter (for Obsidian) to the markdown files in the iso27diy-corp/Corpus/Standards/ISO27x/OST/27001/NL/ directory.

Here is an example for c-6.3-Planning-van-wijzigingen.md:

notetype: reference
standard: ISO 27001
version: 2023
language: NL
type: clause
id: "C.6.3"
title: "Planning van wijzigingen"
tags:
- iso27001/2023/EN
- sourcetext
status: active

id and title are specific to the file, the other kv-pairs are the same for all files.

Do a test run to see if your program has the intended effect. Check back with the user if you encounter exceptions.