Documentation Generator
中级writing最低上下文:32K
Generates comprehensive documentation from code including API references, README files, architecture decision records (ADRs), inline comments, and user guides. Adapts tone and detail level to the target audience (developers, end-users, stakeholders).
使用场景
- Generating API reference documentation from source code
- Writing README files for open-source projects
- Creating Architecture Decision Records (ADRs)
- Producing onboarding guides for new team members
- Documenting complex business logic and workflows
示例提示词
Generate comprehensive documentation for this module. Include: 1. Module overview (purpose, responsibilities) 2. Public API reference (functions, parameters, return types) 3. Usage examples with common patterns 4. Error handling guide 5. Dependencies and prerequisites Target audience: developers integrating this module. Format: Markdown with code examples. Module code: ``` [paste code here] ```
推荐模型
兼容工具
claude-codecursorgithub-copilotkiroany
模态
输入: code, text
→输出: text
相关 Skills
作者
OpenModels Community