documentation-generation-doc-generate
Umfassende Dokumentation aus Code generieren
Halten Sie Ihre Dokumentation automatisch mit dem Code synchronisiert. Dieser Skill extrahiert Informationen aus dem Quellcode, um API-Spezifikationen, Architekturdiagramme und Benutzerhandbücher zu erstellen, die mit der Entwicklung Ihres Codebasises aktuell bleiben.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-generation-doc-generate”。 Analyze Python API routes in src/routes/
预期结果:
- OpenAPI 3.0 specification file (openapi.yaml)
- Interactive API documentation HTML page
- Code examples in Python, JavaScript, and cURL for each endpoint
正在使用“documentation-generation-doc-generate”。 Document the microservices architecture
预期结果:
- System architecture diagram showing service relationships
- Component documentation with technology stacks and responsibilities
- Data flow diagrams for key business processes
安全审计
安全This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
质量评分
你能构建什么
API-Dokumentationsgenerierung
Generieren Sie automatisch OpenAPI-Spezifikationen und interaktive API-Dokumentation aus Ihren Codebase-Annotations- und Routendefinitionen.
Architekturdokumentation
Erstellen Sie Systemarchitekturdiagramme und Komponentendokumentation durch die Analyse von Imports, Abhängigkeiten und Codestruktur.
Dokumentations-Pipeline-Automatisierung
Richten Sie CI/CD-Workflows ein, die bei jedem Code-Commit die Dokumentation regenerieren und bereitstellen, um die Docs synchronisiert zu halten.
试试这些提示
Analyze the Python files in ./src/api/ directory and generate OpenAPI 3.0 specification with all endpoints, request/response schemas, and authentication requirements.
Create a comprehensive README.md for this repository including installation instructions, configuration options, usage examples, and contribution guidelines based on the code structure.
Examine the service modules and their imports to create Mermaid diagrams showing system architecture, data flow, and component dependencies.
Generate complete documentation including API reference, architecture overview, getting started guide, and deployment instructions. Set up a documentation site using the generated artifacts with search functionality.
最佳实践
- Führen Sie die Dokumentationsgenerierung als Teil von CI/CD aus, um die Docs mit Codeänderungen synchronisiert zu halten
- Fügen Sie Dokumentationsabdeckungsprüfungen hinzu, die Builds fehlschlagen lassen, wenn die Abdeckung unter einen Schwellenwert sinkt
- Überprüfen Sie die generierte Dokumentation auf Richtigkeit und fügen Sie bei Bedarf menschlichen Kontext hinzu
避免
- Dokumentation einmal generieren und sie nie aktualisieren, wenn sich der Code weiterentwickelt
- Generierte Dokumentation ohne menschliche Überprüfung auf Richtigkeit veröffentlichen
- Sensible Informationen wie API-Schlüssel oder interne URLs in generierte Docs aufnehmen