Navigation und Metadaten

Die Navigation einer Knowledge Base beschreibt, welche Inhalte verfügbar sind und wie diese strukturiert werden.

Navigation

Eine Navigation kann beispielsweise so aussehen:

sections:
  - id: basics
    title:
      de: Grundlagen
      en: Basics
    items:
      - id: what-is-phishing
      - id: why-phishing-works

  - id: detection
    title:
      de: Phishing erkennen
      en: Recognizing Phishing
    items:
      - id: suspicious-emails
      - id: suspicious-links

Section-ID

Jede Section besitzt eine eindeutige ID.

id: detection

Die ID wird intern verwendet und sollte nach Möglichkeit stabil bleiben.

Artikel-ID

Auch jeder Artikel besitzt eine eindeutige ID.

- id: suspicious-links

Über diese ID kann die Anwendung den zugehörigen Inhalt ermitteln.

Titel

Titel können sprachabhängig definiert werden:

title:
  de: Verdächtige Links
  en: Suspicious Links

Damit kann die gleiche Knowledge Base mehrere Sprachen unterstützen.

Trennung von technischen IDs und sichtbaren Namen

Die technische ID sollte möglichst unabhängig vom sichtbaren Titel sein.

Beispielsweise:

id: suspicious-links

title:
  de: Verdächtige Links
  en: Suspicious Links

Wird der deutsche Titel später geändert, muss die ID nicht geändert werden.

Das verhindert, dass bestehende Verweise auf den Artikel ungültig werden.