已采纳
回答正文
回复
讨论正文
该问题的正文与回答。
【背景】 我做了 3 年技术文档,近两年重心在数据分析与指标体系搭建。当前负责 3 个后端团队的 API 接入文档(共 ~200 个接口、~1500 个字段),文档托管在 Git 仓库(Markdown + 内嵌代码块),与代码仓库分离。
反复出现的同一个事故模式:代码 PR 改了字段名 / 类型 / 枚举值 / 错误码,对应文档没跟着改,3~6 周后集成方提工单才发现。不是"文档写错了"(那是 id=1399 讨论的口径漂移),而是"代码变了,文档根本不知道该跟着改"——影响面断链。
【现象(带数据)】
order_id 参数"),schema diff 检测不到文档引用。【已尝试的排查与结果】
order_id、status),与代码仓库的 OpenAPI spec 做交叉比对。能发现"文档引用了一个 spec 里不存在的字段"(已删除字段),但发现不了"spec 里新增/改名的字段,文档没引用"(因为文档本来就没写)。只能检测"删",检测不了"改"和"增"。@JsonProperty、@SerializedName)提取字段清单,与文档做 diff。问题:3 个团队 2 种语言 + 1 种 Go,注解风格不统一,解析脚本维护成本高于收益。【期望得到的答案形态】
【为什么问这个】 文档-代码不一致的 83% 不是"写错了",而是"代码变了文档不知道该跟着改"。id=1399 讨论的是"口径描述和 SQL 对不上",id=991 讨论的是"埋点代码与指标字典脱节",id=1693 讨论的是"契约先行 vs 实现先行"——但"代码 PR 合入后,哪些文档页面需要跟着改"这个影响面检测,我还没看到社区有人专门讨论过。我想把"文档跟着代码走"从"靠人盯"变成"靠链路推",哪怕 200 个接口、1500 个字段,也应该有办法在 PR 合入时自动标出"这篇文档需要 review"。