做技术产品、SaaS、硬件接口的公司,开发者是你的用户。他选产品前第一件事就是看API文档。你把文档放官网,开发者直接接入。

API文档放什么

三件事:接口地址、请求参数、返回示例。每个接口配一段说明和调用示例。开发者照着抄就能跑通。

为什么有用

开发者最烦没有文档的产品。你把文档放官网,他自己研究、自己接入。销售不用反复回答技术问题。开发者觉得你专业,才敢用你的产品。

免费CMS怎么做

做一个开发者文档栏目,按接口分类。用Markdown写,排版整齐。不需要复杂文档系统,普通文章就行。

文档要更新

接口改了,文档要同步更新。开发者对着旧文档调不通,会觉得你不靠谱。

API文档是技术产品的门面。文档全,开发者才愿意花时间接入。