documentation-templates
Professionelle Dokumentation schnell erstellen
Dieses Skill bietet sofort einsetzbare Vorlagen für README-Dateien, API-Dokumentation, Codekommentare, Changelogs und KI-freundliche Dokumentationsformate.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-templates”。 Verwende documentation-templates, um eine README für eine Node.js API zu erstellen
预期结果:
Eine vollständige README.md mit Abschnitten: Titel + Einzeiler, Quick Start, Features, Konfigurationstabelle, API-Referenz-Link, Contributing-Richtlinien, Lizenz
正在使用“documentation-templates”。 Verwende documentation-templates, um einen GET /users Endpunkt zu dokumentieren
预期结果:
API-Dokumentation mit Endpunktbeschreibung, Parametertabelle (id: string, erforderlich), Antwortcodes (200, 404) und Beispielanfrage/-antwort
正在使用“documentation-templates”。 Verwende documentation-templates, um ein ADR für Datenbankauswahl zu erstellen
预期结果:
ADR-Dokument mit Status (Accepted/Deprecated/Superseded), Context (warum die Entscheidung notwendig ist), Decision (was entschieden wurde), Consequences (Kompromisse)
安全审计
安全All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.
检测到的模式
质量评分
你能构建什么
Neueinrichtung eines Projekts
Schnell Dokumentation für ein neues Projekt mit README-, API-Dokumentations- und Changelog-Vorlagen erstellen.
Dokumentationsstandards
Konsistenten Dokumentationsstil über Teamprojekte hinweg mit standardisierten Vorlagen beibehalten.
KI-Agent-Integration
Dokumentation erstellen, die KI-Agenten wie Claude und Codex verstehen und effektiv nutzen können.
试试这些提示
Verwende das documentation-templates Skill, um eine README.md für mein [project type] Projekt zu erstellen. Füge Abschnitte für Quick Start, Features und Konfiguration hinzu.
Verwende das documentation-templates Skill, um API-Dokumentation für meine REST-API mit Endpunkten für [list endpoints] zu erstellen.
Verwende das documentation-templates Skill, um JSDoc-Kommentare zu meiner Funktion hinzuzufügen, die [describe function purpose].
Verwende das documentation-templates Skill, um ein ADR für [decision title] zu erstellen. Füge Abschnitte für Context, Decision und Consequences hinzu.
最佳实践
- Beginne zuerst mit wichtigen Abschnitten (Titel, Quick Start, Features) bevor du detaillierte Dokumentation hinzufügst
- Verwende Vorlagen als Ausgangspunkte und passe die Struktur an deine Projektanforderungen an
- Halte die Dokumentation aktuell - veraltete Dokumente sind schlimmer als keine Dokumentation
- Füge Beispiele in deiner Dokumentation hinzu, um Benutzern schnelles Verständnis zu ermöglichen
避免
- Kopiere Vorlagen nicht wortwörtlich ohne Anpassung an deinen Projektkontext
- Vermeide die Dokumentation von Implementierungsdetails in benutzerorientierten README-Dateien
- Überspringe nicht den Quick Start-Abschnitt - Benutzer wollen schnell loslegen
- Vermeide veraltete Dokumentationsformate, die KI-Agenten nicht analysieren können