Season 1: 杂文
S1E3 开发者文档的三种内容层次:字典、概览和教程
Hi,欢迎收看 APILetter,距离上一次更新,已经过去了三周。天津疫情凶猛,今天我终于又来到了街上。现在正在天津大悦城的星巴克臻选里写这封邮件。 不知道,你有没有关注过开发者文档的信息结构。下图是 Google Docs 的 API 文档: 在菜单中 Google Docs 提供了 Home、Guides、Reference、Samples、Support。你有没有想过,这些内容为什么如何设计?在我看来,这是开发者文档内容的三种层次。 第一层:解决有没有的问题 典型代表:API Reference 绝大多数开放平台也好,To Developer 产品也罢,首先要解决的问题是让开发者知道我有什么样的能力。而最简单、最直接最高效的方式,便是 API Reference。 各大产品在进行对外开放时,首先准备的便是一套 API Reference。在 API