开发者体验

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

背景 做了 8 年技术文档，最近复盘自己经手过的项目文档，发现一个反复出现的尴尬：同一份「接口接入指南」，有人看完直接上手跑通了，有人看完还是来问「这一步到底点哪里」。差别往往不在读者能力，而在文档的颗粒度——它决定了读者能自己走多远。 我