用途:在功能实现与验证完成后,系统化更新项目全部文档,包括实现文档、用户指南、API 文档、架构图与配置变更。
主要能力:提供五类模板,位于 templates/ 目录:implementation-docs.md 用于 docs/implementation/,记录功能实现方式;user-guide.md 用于 docs/guides/,面向最终用户;api-docs.md 用于 docs/api/,覆盖 REST API 与 Python docstring;architecture-docs.md 用于 docs/architecture/,记录设计决策与图表;configuration-docs.md 用于各类配置、环境变量与 TECH-STACK。
使用方式:按工作流执行。实现文档始终必做,说明方案、架构、安全措施、性能优化、依赖与配置。涉及用户交互变化时更新 README 的安装步骤、CLI 命令、配置与功能,复杂功能另建用户指南。新增或变更 REST API 或公开 Python API 时更新接口文档与 docstring(Args、Returns、Raises 等)。复杂功能使用架构模板记录系统图、组件职责、设计决策与数据流。配置方面更新 .env.example、docs/guides/configuration.md 与 TECH-STACK.md。
适用场景:功能收尾、文档化实现细节、创建或更新用户指南、更新 API 文档、补充架构图、记录配置变更。
限制:资料未提供具体安装命令、价格与平台支持信息;模板需按仓库实际结构使用,代码示例需自行测试。