Zum Inhalt

Artikel erzeugen

🧠 Zusammenfassung

Dieser Artikel definiert die Struktur und Regeln für den Metadatenblock am Anfang jedes Wissensartikels.

Die Metadaten ermöglichen:

  • strukturierte Verarbeitung durch KI-Agenten
  • konsistente Organisation der Wissensdatenbank
  • effiziente Suche und Verlinkung

Jeder Artikel MUSS einen gültigen Metadatenblock enthalten.

🎯 Zweck

  • Standardisierung aller Artikel
  • Ermöglichung automatisierter Verarbeitung
  • Aufbau eines konsistenten Knowledge Graphs

🧩 Metadatenstruktur

Jeder Artikel beginnt mit einem YAML-Block:

---
id: <unique-id>
type: <type>
title: <title>
status: <status>
owner: <owner>
tags:
  - <tag1>
  - <tag2>
references:
  - <article-id>
---

📌 Felddefinitionen

id (Pflicht)

Eindeutige Kennung des Artikels.

Regeln:

  • nur Kleinbuchstaben, Zahlen und -
  • keine Leerzeichen
  • muss global eindeutig sein

Beispiele:

  • knowledge-base-system
  • systems-openclaw
  • process-task-management

type (Pflicht)

Definiert die Art des Inhalts.

Erlaubte Werte:

  • knowledge → allgemeines Wissen
  • process → Abläufe
  • decisions → Architektur- oder Business-Entscheidungen
  • agent → Beschreibung eines Agenten

title (Pflicht)

Menschlich lesbarer Titel.

Regeln:

  • frei formuliert
  • sollte den Inhalt klar beschreiben

status (Pflicht)

Lebenszyklus des Artikels.

Erlaubte Werte:

  • draft → in Arbeit
  • active → gültig und aktuell
  • deprecated → veraltet, nicht mehr verwenden

owner (Empfohlen)

Verantwortliche Instanz.

Beispiele:

  • system
  • human

ai-readable (Empfohlen)

Ob KI Agenten diesen Artikel lesen dürfen.

Beispiele:

  • true
  • false

tags (Empfohlen)

Thematische Klassifikation.

Regeln:

  • kurze, englische Begriffe
  • keine Sätze

Beispiele:

  • knowledge-base
  • architecture
  • authentication

references (Optional, aber empfohlen)

Verweise auf andere Artikel.

Regeln:

  • referenziert die id anderer Artikel
  • keine URLs
  • keine Dateipfade

Beispiel:

references:
  - systems-knowledge-base
  - systems-sso

Struktur eines Artikels

Es gibt folgende Vorlagen um die grundsätzliche Struktur eines Artikels festzulegen:

🔗 Referenzierung im Text

Innerhalb des Artikels werden Referenzen so verwendet:

siehe [Technische Informationen zur Wissensdatenbank](../02-systems/01-hyperion/knowledge-base.md)

Regel:

  • undefined muss einem Eintrag in references entsprechen

⚠️ Validierungsregeln

Ein Artikel ist ungültig, wenn:

  • id fehlt oder nicht eindeutig ist
  • Pflichtfelder fehlen (id, type, title, status)
  • references auf nicht existierende Artikel zeigen
  • ungültige Werte verwendet werden (z. B. falscher type)

🤖 Regeln für KI-Agenten

Beim Erstellen oder Ändern von Artikeln müssen Agenten:

  1. IMMER das Metadaten-Template verwenden
  2. eine eindeutige id generieren
  3. den passenden type wählen
  4. status korrekt setzen (draft oder active)
  5. vorhandene Artikel referenzieren statt duplizieren
  6. Referenzen konsistent halten

❌ Verboten

  • freie oder inkonsistente Metadatenstruktur
  • Verwendung von URLs in references
  • fehlende Pflichtfelder
  • doppelte IDs

🔁 Pflege

Metadaten müssen aktualisiert werden, wenn:

  • sich der Status eines Artikels ändert
  • neue Abhängigkeiten entstehen
  • Artikel veraltet sind

🔗 Verwandte Themen

  • knowledge-base-template.md
  • conventions.md

⚠ Hinweise / Notizen

  • Metadaten sind wichtiger als Fließtext für KI-Agenten
  • Konsistenz ist entscheidend für die Qualität der Wissensdatenbank
  • Im Zweifel: bestehende Artikel erweitern statt neue erstellen