Trigger Conditions
Activate this skill when the user requests document generation, technical documentation writing, API documentation generation, or project description.
Workflow
- Scan project structure — Identify the project type (Web application/CLI tool/library/service)
- Analyze code — Extract signatures and comments of modules, functions, classes, and interfaces
- Generate documentation — Output the following documentation:
Generated Content
- Project Overview — Chinese introduction, tech stack, architecture diagram (Mermaid)
- Quick Start — Installation, configuration, and running steps
- API Reference — Automatically generated interface documentation
- Usage Examples — Code examples for common scenarios
- FAQ — FAQ section
Output Format
Generate one or more Markdown files, primarily in Chinese, with technical terms kept in English.
Tips
- Prioritize reading existing README, package.json, and pyproject.toml to obtain project metadata
- Analyze import/require statements to infer dependencies
- Extract existing documentation from docstring/JSDoc