用途:检测代码改动是否有相应文档更新,从代码 diff 推断需要更新的文档并报告未覆盖缺口,产出可执行的补文档清单。
主要能力:解析代码 diff 范围;归类代码变更区域;依据映射规则推断应更新的文档;对比当前分支文档改动;输出 missing/partial/covered 对齐结果与补齐建议;生成 Code-Doc Alignment Report,含摘要、对齐缺口、推荐文档更新,缺口条目包含 id、category(api_drift / config_drift / behavior_drift / removed_feature)、code_location、doc_location、evidence、suggested_update,并在报告末尾提供 YAML 机器可读块 alignment_gaps。
使用方式:输入 base 或 diff 范围,可选 docs 根路径与区域映射规则。获取 diff 使用命令 git diff <base>...HEAD --name-status --diff-filter=MAD。默认输出路径为 docs/calibration/code-doc-alignment.md;若项目规范声明了 code-doc-alignment artifact_type 的 path_pattern,则使用项目值。
适用场景:PR 合并前文档门禁、发版前代码变更回查。
限制:不修改代码与文档文件,仅输出评估和建议;不负责文档规范评估、链接图与 SSOT 相关分析。示例:src/api/auth.py 修改但 docs/architecture/api.md 未更新,判定为 high。