documentation-generation-doc-generate
Generate comprehensive documentation from code
Keep your documentation synchronized with code automatically. This skill extracts information from source code to create API specs, architecture diagrams, and user guides that stay current as your codebase evolves.
下載技能 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 Documentation Generation
Automatically generate OpenAPI specifications and interactive API documentation from your codebase annotations and route definitions.
Architecture Documentation
Create system architecture diagrams and component documentation by analyzing imports, dependencies, and code structure.
Documentation Pipeline Automation
Set up CI/CD workflows that regenerate and deploy documentation on every code commit to keep docs synchronized.
試試這些提示
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.
最佳實務
- Run documentation generation as part of CI/CD to keep docs synchronized with code changes
- Include documentation coverage checks that fail builds when coverage drops below threshold
- Review generated documentation for accuracy and add human context where needed
避免
- Generating documentation once and never updating it as code evolves
- Publishing generated documentation without human review for accuracy
- Including sensitive information like API keys or internal URLs in generated docs