when-documenting-code-use-doc-generator
Dokumentation automatisch generieren
Manuelle Dokumentation ist zeitaufwändig und oft veraltet. Dieses Skill generiert automatisch umfassende API-Dokumentation, README-Dateien, Inline-Kommentare und Architekturdiagramme durch Analyse der Code-Struktur.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“when-documenting-code-use-doc-generator”。 Generate API documentation for this Express.js project
预期结果:
- Generated docs/api.yml with OpenAPI 3.0 specification
- Created docs/API.md with endpoint documentation
- Found 12 endpoints across 4 route files
正在使用“when-documenting-code-use-doc-generator”。 Create a README for this Node.js project
预期结果:
- Created README.md with sections: Overview, Installation, Usage, API
- Added badges for CI, coverage, and license
- Included table of contents with anchor links
安全审计
低风险Documentation generation skill with legitimate shell scripts for code analysis. All static findings are false positives or standard operations for documentation tools. Shell scripts use find/grep/xargs for code scanning, URLs are template references, and credential mentions are documentation only.
低风险问题 (1)
风险因素
⚡ 包含脚本
质量评分
你能构建什么
Neues Projekt einrichten
Schnelles Generieren einer initialen Dokumentationsstruktur für ein neues Projekt einschließlich README, API-Spezifikationen und Inline-Kommentar-Vorlage.
Legacy-Code-Dokumentation
Hinzufügen von Dokumentation zu undokumentierten Legacy-Codebasen durch Analyse der vorhandenen Struktur und Generierung geeigneter Docstrings.
API-Dokumentation aktualisieren
Aktualisierung veralteter API-Dokumentation durch Neugenerierung von OpenAPI-Spezifikationen aus aktuellen Code-Endpunkten.
试试这些提示
Use the documentation generator skill to create OpenAPI 3.0 documentation for this project. Look for Express.js, FastAPI, or NestJS routes and generate a complete API specification in docs/api.yml.
Generate a comprehensive README.md for this project. Include sections for overview, installation, usage, API reference, and contributing guidelines. Extract project name, version, and dependencies from package.json or pyproject.toml.
Analyze the source code and add JSDoc comments to all public functions, classes, and interfaces. Include parameter types, return types, and descriptions where documentation is missing.
Generate complete documentation for this project including: (1) README.md with badges and table of contents, (2) OpenAPI specification for all endpoints, (3) architecture diagram showing component relationships, (4) inline comments for undocumented code.
最佳实践
- Dokumentationsgenerierung auf frischen Klonen ausführen, um Offenlegung sensibler Daten zu vermeiden
- Generierte Dokumentation vor dem Commit in die Versionskontrolle überprüfen
- Das --overwrite-Flag vorsichtig verwenden, da es bestehende Dateien ersetzt
避免
- Dokumentationsgeneratoren auf Produktionssystemen mit aktiven Zugangsdaten ausführen
- Erwarten, dass generierte Dokumentation gründliche Code-Reviews ersetzt
- Dokumentationslücken ignorieren, die in der Analysephase identifiziert wurden