用途:产出并维护面向用户与开发者的文档,覆盖 README、API 文档、运维手册(runbook)和代码内注释,让项目可被理解、使用与运维。
适用时机:用户要求 README、API 文档、runbook 或“写文档”;新增或变更公开 API、配置或环境变量;新人上手所需的安装、架构或运维步骤;实现需要用户或运维文档的新功能之后。
核心原则:准确性优先,文档须与当前行为一致,尽量与代码/配置同一次变更更新;按读者(新开发者、运维、外部 API 使用者)匹配语气与深度;保持可发现性,README 作为入口并链接 API 文档、runbook 与贡献指南,避免孤立页面;步骤可执行,命令示例应能运行或注明前置条件。
工作流程:一、确定类型与读者(README、API、runbook、代码内);二、收集现状,如依赖清单与入口(package.json、requirements.txt、go.mod、Cargo.toml)、主脚本、环境变量、路由与请求响应、部署与回滚脚本等,优先以 OpenAPI 或代码为准;三、起草或更新,沿用现有结构与风格,流程给编号步骤、命令、预期结果及失败处置,API 给方法、路径、鉴权、请求响应、状态码与示例,不要臆造行为,不确定时注明需在代码中核实或提问;四、交叉链接与复核,README 链接 API 文档、runbook、CONTRIBUTING、LICENSE,检查命令与路径是否与仓库一致。
主要能力:按结构生成 README(项目名、一句话说明、快速开始、主命令表、配置、项目结构、文档链接、许可);按端点整理 API 文档(方法与路径、鉴权、请求、响应、示例、限流或废弃说明),有 OpenAPI 时优先同步生成;编写 runbook(用途、前置条件、编号步骤、验证方式、回滚、联系人,不写入密钥);规范代码内文档(JSDoc/docstring 写摘要、@param、@returns、@throws,注释说明非显而易见的“为什么”,不做冗余注释)。
限制与注意:文档中不得包含密钥或凭证,应引用 .env 或密钥管理服务;避免从其他项目复制后不改编;公开 API 不应只写“详见代码”;不编造未提供的功能、价格或平台信息;缺少事实应明确标注暂未提供。