用途:在需要根据代码库创建或大幅更新工程文档时使用,包括 README、CONTRIBUTING、安装/操作指南、API 参考、架构说明等。目标是让目标读者能完成任务、查到事实或理解决策,内容基于仓库中已验证的事实。
主要能力:识别文档受众、单一主要用途与所需事实;检查代码、配置、脚本、测试及既有术语;只撰写服务于该用途的章节,TEMPLATES.md 中的示例仅作菜单而非强制模板;核对变更后的链接、路径、命令、名称、默认值与示例;交付时报告未能运行或确认的内容。
使用方式:先读取适用的仓库说明与目标或相邻文档,再据代码、配置、脚本、测试确定事实后起草。若为仅评审请求,只返回发现不改文件;若要求创建或更新文档,只改指定文档范围并保留无关内容。TEMPLATES.md、PATTERNS.md、CHECKLIST.md 为可选参考文件,分别用于章节模式、问题示例与交付前检查。
按用途必需内容:入门或上手需前置条件、受支持的设置路径、命令与成功检查;执行任务需前置条件、有序操作、可观察验证与有证据的故障恢复;API 或选项查询需名称、类型、必需/默认行为、约束、示例与错误;架构说明需背景、当前设计、边界与数据流、理由与权衡;决策记录需状态、背景、决策、备选方案与后果;贡献变更需环境设置、检查、仓库约定与提交流程。
限制:证据缺失或矛盾时应标记空白,不得编造数值、错误信息或验证结果;不得暴露真实凭据或暗示未运行的示例已测试;不得把每份文档写成 README 形态;代码可证明当前行为,但规格可能描述期望行为,冲突需呈现而非静默取舍。交付时需说明创建或变更的文件、非显然事实所用仓库证据、已运行检查及结果、未解决事实或未执行命令。