用途
该技能用于创建、审计或整合项目的长期文档,包括功能规则、契约、工作流和运行手册。其核心目标是捕获代码本身无法解释的持久含义:业务意图、归属、不变量、权限、契约和运维决策。实现细节和可执行证据由源码与测试负责。
主要能力
- 查找并核实文档归属者与证据:读取相关文档索引和归属者,对照源码、测试、模式、配置和运行时证据验证受影响的事实。
- 识别适用范围:针对当前范围,识别适用的参与者、触发器、规则、状态转换、输入/输出、副作用、失败路径、归属和兼容性要求;省略无关类别,记录未解决的重要事实而不编造。
- 按变更类型更新文档:
- 内部重构、格式化或恢复已记录行为的修复:仅更新受影响的路径或证据锚点(如有)。
- 用户行为、业务规则或工作流:更新其现有归属者。
- API、模式、权限、事件或兼容性:更新契约及受影响的消费方映射。
- 设置、迁移、部署、备份或恢复:更新所属运行手册。
- 实体重命名、移动或删除:修复发现路由和过时引用。
- 重复或矛盾文档:在一个归属者中保留有效事实,修复链接,然后在范围内移除过时副本。
- 避免仅记录任务活动的文档变更:临时计划、命令日志和 CI 输出应保留在任务、PR 或现有证据表面,除非它们代表持久的运维要求。
- 面向发现与维护的写作:为每个持久事实指定清晰归属;消费方链接到它并仅记录自己的映射或约束;遵循仓库布局;仅在真实的发现或工具需求证明其维护合理时添加路由器、注册表或元数据;使用具体规则、稳定可搜索的标题、示例和少量源码/测试锚点;优先使用符号和路径而非脆弱的行号;区分事实、建议和未知项;移除通用教程、推测性需求、复制的实现和会腐化的状态元数据;当历史记录仍服务于审计、迁移或运维目的时保留它们;对于被取代的已跟踪内容,Git 历史足够时使用 Git 历史。
- 验证与报告:从现有入口点追踪发现到更新后的归属者;检查链接、标识符、命令、证据锚点和任何受影响的消费方契约;搜索矛盾副本和旧名称;运行聚焦的文档或生成验证器以及适用的必需门禁;仅当变更影响可执行行为或其契约时,才需要应用测试。报告更改的持久事实、重要移除或整合、验证情况和剩余缺口。
使用方式
默认在主对话中运行。委派可能增加使用量:在使用子代理之前,须获得对提议的代理数量和范围的明确批准。在该批准范围内重用该批准;在扩大批准的数量或范围之前再次询问。
阅读模板:对于文档类型,阅读 templates.md;对于多归属者结构,阅读 architecture.md;对于整合,阅读 audit-cleanup.md。
适用场景
- 需要创建或更新功能规则、契约、工作流、运行手册等长期项目文档时。
- 需要审计现有文档的准确性、归属和一致性时。
- 需要整合重复或矛盾的文档时。
- 当文档是主要交付物或变更涉及持久含义变化时。
限制
- 不记录实现细节和可执行证据,这些由源码和测试负责。
- 不记录仅反映任务活动的临时计划、命令日志和 CI 输出,除非它们代表持久的运维要求。
- 不编造未解决的重要事实。
- 使用子代理需要事先获得明确批准。
- 应用测试仅在变更影响可执行行为或其契约时才需要。
- 关于收费、价格、平台等具体信息暂未提供。