Was macht living-docs-skill?
Gezielte Living-Docs-Fähigkeiten zum Einrichten, Navigieren und Pflegen von quellverknüpfter Designdokumentation.
Überblick
Dieser Skill hilft dabei, eine lebendige Dokumentation zu erstellen und zu pflegen, die immer auf dem neuesten Stand ist. Er ist ideal für Teams, die eine enge Verknüpfung zwischen Code und Dokumentation anstreben.
Hauptfunktionen
- Bootstrapping: Automatische Erstellung einer anfänglichen Dokumentationsstruktur basierend auf dem aktuellen Code.
- Navigation: Einfaches Auffinden von Dokumentation zu bestimmten Code-Komponenten.
- Wartung: Aktualisierung der Dokumentation bei Code-Änderungen und Erkennung von Inkonsistenzen.
Unterstützte Plattformen
Dieser Skill ist konzeptionell und funktioniert mit jeder KI-Agent-Plattform, die die Arbeit mit Dateien und Markdown unterstützt, wie z. B. Claude Code, Cursor oder Codex.
Verwendung
Um den Skill zu aktivieren, fügen Sie die entsprechenden Anweisungen in Ihre Agent-Konfiguration ein. Der Skill erwartet, dass Dokumentationsdateien in einem bestimmten Verzeichnis (z. B. docs/) abgelegt sind und nach einem festgelegten Schema benannt werden.
Beispiel: Bootstrapping
# Befehl zum Erstellen der Dokumentationsstruktur
living-docs init
Dies erzeugt eine grundlegende Dokumentation, die auf den vorhandenen Modulen und Funktionen basiert.
Verknüpfung mit Code
Dokumentation wird in Markdown-Dateien gespeichert. Die Verknüpfung mit Code erfolgt über Kommentare oder spezielle Tags (z. B. <!-- doc:src/main.ts -->). Dadurch kann der Skill automatisch erkennen, welche Dokumentation zu welchem Code gehört.
Vorteile
- Immer aktuell: Durch die Verknüpfung mit Code wird verhindert, dass die Dokumentation veraltet.
- Zeitersparnis: Automatisierte Generierung und Aktualisierung reduziert manuellen Aufwand.
- Bessere Zusammenarbeit: Entwickler und andere Teammitglieder haben jederzeit Zugriff auf konsistente Informationen.
Weitere Informationen und Anpassungsmöglichkeiten finden Sie in der offiziellen Dokumentation.