C4 Code Level: [Directory Name]
C4-Codedokumentation generieren
Codebasen fehlt eine konsistente, strukturierte Dokumentation auf Codeebene. Diese Fähigkeit erstellt eine umfassende C4-Code-Level-Dokumentation mit Funktionssignaturen, Klassenhierarchien und visuellen Diagrammen.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "C4 Code Level: [Directory Name]". Analysieren Sie das src/api-Verzeichnis und erstellen Sie C4-Code-Level-Dokumentation
Erwartetes Ergebnis:
Vollständige Dokumentation einschließlich Funktionssignaturen mit Parametern und Rückgabetypen, Klassendefinitionen mit Methoden, Abhängigkeitslisten und einem Mermaid-Klassendiagramm, das die API-Layer-Struktur zeigt.
Verwendung von "C4 Code Level: [Directory Name]". Erstellen Sie ein Datenpipeline-Diagramm für die ETL-Transformer
Erwartetes Ergebnis:
Mermaid-Flowchart, der die Datentransformations-Pipeline von Roheingang über Validierung, Transformation, Normalisierung und Aggregationsstufen bis zur endgültigen Ausgabe zeigt.
Sicherheitsaudit
SicherThis is a prompt-only documentation skill with no executable code, network access, or external dependencies. Static analysis found zero security issues. The skill provides templates and guidance for creating C4 code-level documentation using Mermaid diagrams.
Qualitätsbewertung
Was du bauen kannst
Neue Code-Module dokumentieren
Beim Hinzufügen neuer Funktionen zu einer Codebasis C4-Code-Dokumentation generieren, um konsistente Dokumentationsstandards für die neuen Module aufrechtzuerhalten.
Neue Teammitglieder einarbeiten
Umfassende Code-Dokumentation für unbekannte Teile der Codebasis erstellen, um neuen Entwicklern zu helfen, die Struktur schnell zu verstehen.
Code für Übergabe vorbereiten
Vollständige Code-Dokumentation vor der Übertragung des Eigentums von Modulen zwischen Teams oder Auftragnehmern generieren.
Probiere diese Prompts
Analysieren Sie das src/auth-Verzeichnis und erstellen Sie C4-Code-Level-Dokumentation mit allen Funktionen, deren Signaturen und Abhängigkeiten.
Dokumentieren Sie den Service-Layer-Code mit vollständigen Klassenhierarchien, Interface-Implementierungen und einem Mermaid-Klassendiagramm.
Analysieren Sie die ETL-Pipeline in src/pipeline und erstellen Sie ein Datenflussdiagramm, das alle Transformationsfunktionen und ihre Komposition zeigt.
Dokumentieren Sie das gesamte handlers-Paket einschließlich aller Structs, Methoden, Funktionsabhängigkeiten, und erstellen Sie sowohl ein Modulstrukturdiagramm als auch einen Funktionsabhängigkeitsgraphen.
Bewährte Verfahren
- Fügen Sie immer vollständige Funktionssignaturen mit allen Parametertypen und Rückgabetypen ein
- Verwenden Sie konsistente Namenskonventionen für alle Dokumentationselemente
- Fügen Sie tatsächliche Dateipfade und Zeilennummern für Code-Referenzen ein
Vermeiden
- Dokumentation erstellen, ohne den eigentlichen Quellcode zu überprüfen
- Übermäßig komplexe Diagramme für einfache Codestrukturen verwenden
- Abhängigkeitsinformationen weglassen, die Entwickler zum Verstehen des Codes benötigen