Wie die Knowledge Base funktioniert

Die Knowledge Base trennt die Verwaltung der Inhalte von deren Darstellung.

Das grundlegende Prinzip ist:

Navigation
     │
     ▼
 Artikel-ID
     │
     ▼
 Markdown-Datei
     │
     ▼
 Markdown Parser
     │
     ▼
 HTML
     │
     ▼
 Webseite

1. Navigation laden

Beim Aufrufen einer Knowledge Base wird zunächst deren Navigation geladen.

Die Navigation beschreibt die vorhandenen Sections und die darin enthaltenen Artikel.

Beispiel:

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

2. Artikel auswählen

Wählt der Benutzer einen Artikel aus, wird dessen ID verwendet.

Beispielsweise:

what-is-phishing

Die Anwendung kann anhand dieser ID den entsprechenden Artikel ermitteln.

3. Markdown laden

Der Artikel wird anschließend als Markdown geladen.

Beispiel:

# Was ist Phishing?

Phishing bezeichnet den Versuch, Benutzer durch Täuschung zur
Preisgabe vertraulicher Informationen zu bewegen.

4. Markdown verarbeiten

Der Markdown-Inhalt wird von der Anwendung verarbeitet und in HTML umgewandelt.

Dadurch kann der Inhalt innerhalb der Webseite dargestellt werden.

5. Darstellung

Das erzeugte HTML wird anschließend in das Layout der Knowledge Base eingebettet.

Damit bleiben Navigation, Header und andere Bestandteile der Webseite von den eigentlichen Artikeln getrennt.

Warum diese Trennung?

Die Architektur ermöglicht es, die gleiche Knowledge-Base-Logik für unterschiedliche Quellen zu verwenden.

Heute können die Artikel beispielsweise aus Dateien kommen:

Markdown-Dateien
      │
      ▼
Knowledge Base

Später können die gleichen Inhalte aus einer Datenbank kommen:

Datenbank
   │
   ▼
Knowledge Base

Die Darstellung der Artikel muss sich dadurch nicht grundsätzlich ändern.

Dies ist besonders relevant, wenn Knowledge Bases später von Benutzern erstellt und bearbeitet werden können.