用途:对照仓库当前实现、配置、脚本、测试或规范,审查现有文档中的命令、路径、名称、版本、默认值、环境变量、API、架构及弃用或迁移指引是否仍然准确,并正确分类不一致。\n\n两种模式:Audit(审查)只给出有证据的发现,不改文件;Sync(同步)修补已确认的文档漂移,并验证受影响的路径、命令与链接。仅当用户要求修复、更新或同步时使用 Sync;要求审查某一区域并不授权全仓库改写。\n\n主要能力:用 rg --files 盘点范围内的 Markdown、MDX、reStructuredText 文件;提取与决策相关的声明;逐条追溯证据并分类。分类包括:文档漂移(实现在前、文档应跟进)、实现漂移(规范文档描述预期契约、代码疑似有误)、文档冲突(两份维护页面互相矛盾且无明确归属)、失效引用(路径、链接、锚点、命令或名称无法解析)、模糊(无法判定哪一方权威)。\n\n用法要点:可从声明出发搜索,例如 rg --files -g '.md' -g '.mdx' -g '*.rst',再用 rg -n 'deprecated|obsolete|legacy|removed|renamed|unfinished|placeholder' <scope>;随后在代码、配置、测试与 CI 中搜索精确命令、标识符、环境变量与路径。对当前行为,可执行证据通常比散文更有力;规范或 ADR 可能有意描述期望行为,代码与文档不一致不自动等于文档漂移。\n\n修补规则:保留文档语言、结构与语气;只改解决已确认不一致的最小片段;识别维护主页面后再更新副本;有验证过的迁移路径才替换弃用指引,否则说明该功能已移除或不支持,不编造替代方案;不要因为两份指南通常相似就整体覆盖。\n\n验证与限制:确认本地路径与锚点存在,对脚本与配置核对命令并在比例适当时运行安全的聚焦命令,在源头确认名称、签名、默认值与弃用状态,搜索残留的过时变体,检查 diff 是否有无关改动,并运行仓库可用的文档检查。需记录实际命令结果,仅检查不等于运行验证。Sync 模式下修补文档漂移与失效引用;实现漂移与模糊冲突仅作报告,除非用户同时要求改代码或已提供缺失决策。上游文档具时效性,本地声明依赖外部版本时需核对当前官方来源。
docs-conflict-deprecation-review
编程与开发
更新于 10-16 08:47