E41240390-SaifulRizal-A/claude-interaktiver-dokumentationsworkflow
📝 Optimieren Sie Ihre technische Dokumentation und Implementierung mit einem strukturierten Workflow, der KI nutzt, um Klarheit zu verbessern und technische Schulden zu reduzieren.
Übersicht
Dieser Skill führt Sie durch einen systematischen Prozess zur Erstellung, Aktualisierung und Implementierung technischer Dokumentation. Er ist ideal für Entwickler, die mit KI-Agenten wie Claude Code, Cursor oder Codex arbeiten, und unterstützt die Automatisierung von Dokumentationsaufgaben.
Hauptfunktionen
- Analyse: Untersucht bestehende Codebasen auf Dokumentationslücken.
- Generierung: Erstellt Docstrings, Inline-Kommentare und Benutzerdokumentation.
- Integration: Passt Dokumentation in den Entwicklungs-Workflow ein.
- Konsistenz: Stellt sicher, dass alle Dokumentationen einheitlichen Standards folgen.
Unterstützte Plattformen
- Claude Code
- Cursor
- Codex
- Andere KI-Assistenz-Tools
Verwendung
-
Starten Sie den Workflow mit einem Befehl wie:
claude-code --skill documentation-workflow -
Folgen Sie den interaktiven Schritten zur Analyse Ihrer Codebasis.
-
Lassen Sie KI-Vorschläge für Verbesserungen generieren.
-
Übernehmen Sie die Änderungen und integrieren Sie sie in Ihr Projekt.
Konfiguration
Passen Sie den Workflow über die Datei workflow-config.yaml an:
output_format: markdown
auto_generate: true
target_files:
- "src/**/*.py"
- "docs/**/*.md"
Beispiel
def add(a, b):
"""Addiert zwei Zahlen und gibt das Ergebnis zurück."""
return a + b
Nach der Anwendung des Workflows wird die Funktion verbessert:
def add(a: int, b: int) -> int:
"""
Addiert zwei ganze Zahlen.
Args:
a: Erster Summand.
b: Zweiter Summand.
Returns:
Summe von a und b.
"""
return a + b
Lizenz
MIT