Konventionen

🧠 Zusammenfassung¶

Hier sind die Konventionen der Wissensdatenbank beschrieben.

🎯 Zweck¶

Sicherstellen, dass Agenten Wissen gut nachlesen können
Definition aller Konventionen und Regeln an einem Ort
Sicherstellung von Konsistenz, Nachvollziehbarkeit und Erweiterbarkeit

📦 Kontext¶

-

🧩 Details¶

Die Wissensdatenbank wurde durch eine umfangreiche Analyse mit folgenden Entscheidungen geformt und danach umgesetzt. Wichtig sind klare Regeln und Konventionen, damit Mensch und KI gleichermassen damit umgehen kann. (siehe Aufbau Wissensdatenbank - Entscheidungen)

Generelle Regeln:

Tasks aus Kanban referenzieren Wissen — Wissen referenziert keine Tasks im Kanban
Strukturelle Erweiterungen müssen immer mit den menschlichen Usern abgesprochen werden

🗂 Struktur¶

Alle Inhalte sind in einer festen Folder-Struktur organisiert - diese Struktur darf nicht beliebig verändert werden.

Neue Inhalte müssen in die passende Kategorie eingeordnet werden - hierfür siehe die verlinkten Übersichtsseiten:

In jedem Folder ist zwingend ein index.md File abgelegt, welches entweder eine Übersichtsseite darstellt, oder den Hauptartikel bei wenigeren Inhalten bzw. wenn es in diesem Folder kein weiteren Sub-Folder gibt.

📝 Artikel erstellen (für Menschen & KI-Agenten)¶

Jeder neue Artikel MUSS auf Basis eines der folgenden Templates erstellt werden:

Wissensartikel siehe Artikeltemplate - Wissensartikel
Prozessbeschreibung siehe Artikel Template - Prozess
Entscheidungen siehe Artikeltemplate - Entscheidungen

👉 Diese Vorlagen sind verbindlich und bilden die Grundstrukturen für jeden Artikel.

Am Anfang eines Artikels sind immer Metadaten zu befüllen.

In Artikeln wird wie folgt auf andere Artikel verlinkt:

undefined

→ verweist auf einen anderen Artikel in der Wissensdatenbank über die Id im Metadatenblock des Artikels.

Vorgehen für KI-Agenten¶

Wenn ein Agent Wissen dokumentieren möchte:

Passenden Kontext bestimmen (Projekt / System / Knowledge etc.)
Zielpfad nach Kontext heraussuchen
Neue Datei im entsprechenden Pfad erstellen
Inhalt vom passenden Template in die neue Datei einfügen
Inhalt anhand der Struktur vollständig ausfüllen
Inhalt klar, strukturiert und präzise formulieren
Relevante Dokumente verlinken
Benachrichtigung über neuen Artikel im #wdb Slack Channel

Verboten¶

❌ Keine freien Formate
❌ Keine unstrukturierte Textablage
❌ Kein Überspringen der Template-Struktur
❌ Keine Duplikate bestehender Inhalte

🌍 Sprachkonvention¶

Folderstruktur und Filenamen → Englisch
Inhalte → Deutsch
Schlüsselbegriffe → Englisch (konsequent!)

Beispiele:

User (nicht: Benutzer oder Anwender wechseln)
Task (nicht: Aufgabe)
Goal
System
Feature

Für die vollständige Liste siehe Glossar

👉 Ziel: Konsistenz für KI-Verarbeitung