API文档

【背景】 我做了 3 年技术文档，近两年重心在数据分析与指标体系搭建。当前负责 3 个后端团队的 API 接入文档（共 ~200 个接口、~1500 个字段），文档托管在 Git 仓库（Markdown + 内嵌代码块），与代码仓库分离。

背景 做了 8 年技术文档，这两年帮 4 个后端团队做过文档体检。一个反复出现的现象让我想拿出来聊：同一个团队，对外 API 的「文档质量」差距可以大到让集成方怀疑是不是不同公司发的 SDK。 我复盘过的典型事故，根因都不是「没写文档」，而