用途:保持文档与项目当前状态一致。它把过期文档视为项目缺陷,但要求避免因纯内部改动而产生无谓的文档波动。
默认流程:编辑文档前先查看相关现有文档;判断任务是否改变接口、结构或项目知识;完成代码或项目改动;通过读取修改后的文件或 git diff 核实真实变更,而不是凭记忆;只更新受影响的文档;检查代码、README、docs、changelog 与 agent 指南之间是否存在矛盾;最后在回复中总结文档工作。
何时更新:当公开行为、API、路由、CLI 命令、配置、环境变量、schema、文件格式、安装或用法改变;架构、模块职责、依赖边界、部署、运维或贡献流程改变;或产生重要决策、长期权衡、已发现的限制、技术债时更新。纯内部重构、测试、格式化、无可见行为变化的小修复通常不更新,除非现有文档会因此误导。
依据:只能基于可验证证据撰写,包括 git diff 或修改后的文件、README 与现有 docs、AGENTS.md 或 CLAUDE.md、package scripts 与构建配置、源码导出与路由/CLI/配置 schema、测试与示例、用户明确指示。不得编造命令、支持状态、API、性能声明、兼容性承诺或部署步骤。
限制与守则:改动规模与项目变更成比例,优先外科手术式编辑;保留警告、限制、合规、安全与运维手册;不记录秘密或敏感数据;不重复权威来源而应链接;不创建空文件或占位内容;不重命名或移动既有文档,除非用户要求或结构明显损坏。
引导与决策记录:文档缺失时按项目规模创建最小可用集合,不创建空占位文档。只有长期、难以逆转、跨模块或带重要权衡的决策才写 ADR。
完成前按严重度修正:Critical(描述已删除的行为/命令/配置/路由或遗漏新增必需步骤)、High(与代码、示例、测试或元数据矛盾)、Low(不可验证声明或已过时的 TODO)。若未改文档,需说明行为、API、设置与架构未变。