用途:在功能、事故、发布、评审等事件后维护项目知识,让文档既可信又精简,并放在未来人和智能体都能找到的位置。仅当用户要求分析时,返回文档计划而不修改文件。
主要能力:按知识类型分类,包括操作手册/运行手册、参考(命令、配置、API、环境变量、权限、模式)、概念解释、ADR 决策、变更日志/发布说明、学习/事后复盘、清理过时或矛盾文档。优先更新既有持久位置:README 用于入口、安装与常见用法;docs/ 用于深入指南、架构与运行手册;ADR 目录或决策日志用于架构选择;CHANGELOG/发布说明仅记录用户或运维可见变更;技能 references/ 用于可复用智能体流程而非项目历史。避免在多文件重复同一事实,除非其中一个是链接到规范来源的摘要。
使用方式:开始前加载 references/safety.md;决定信息归属或更新文档前加载 references/documentation-rubric.md;解释文档模型或用户询问依据时加载 references/source-literature.md。写前对照可观察的仓库上下文:当前文件、命令、脚本、配置、清单、测试与示例,近期 diff 或提交,既有术语与风格,过时指令、旧路径、矛盾设置或缺失前置条件。无法核实时标记为假设或询问缺失来源。按正确形态写最小持久更新:README 更新、运行手册(前置条件、只读检查、操作步骤、回滚、验证)、ADR(状态、上下文、决策、后果、备选)、学习记录(触发、根因或洞见、持久变更、跟进负责人)、变更日志(按仓库风格使用 added/changed/fixed/deprecated/removed/security)。最后返回文档状态(updated | plan only | blocked)、变更列表、规范真相位置与未决问题。
限制与护栏:不要仅因信息存在就创建文档;不要为怀旧保留过时文档,应更新、合并、归档或删除;不要把决策只埋在 PR 描述或聊天摘要中;不要把发布说明写成内部实现日志;不要编造命令、环境变量、架构或运维保证。保持文档对智能体友好:稳定路径、精确命令、明确归属。资料未提供具体安装命令、收费或平台信息。