用途:为代码库编写面向初学者的文档,包括 README、架构文档、代码注释和 API 文档。
主要能力:提供四类文档的结构模板与写作原则,如先讲“为什么”、渐进式披露、提供示例、解释术语、使用图示与文件树、帮助用户在 5 分钟内跑起来。README 涵盖快速开始、项目结构、关键概念、常见任务与故障排查;架构文档涵盖系统设计、目录结构、数据流、设计决策与扩展点;代码注释强调解释业务逻辑与边界情况;API 文档涵盖认证、请求响应格式、curl 示例与常见错误。
使用方式:先分析代码库入口、依赖、核心概念与配置,再按需选择文档类型,优先顺序为 README → 架构 → API → 注释。可使用 assets/templates/ 下的模板,并可参考 references/documentation_guidelines.md 与 references/visual_aids_guide.md。示例指令包括“Create a README file for this project that helps new developers get started”等。
适用场景:新项目缺少 README、多模块项目需要架构说明、代码逻辑难以理解、需要公开 HTTP/API 接口文档,以及企业代码库的文档标准化。
限制:资料未提供具体安装命令、运行环境要求、收费方式或平台支持信息,暂未提供。