程序员在哪里写文档

GitHubPages。

现在大多程序员都会使用通用代码库Github，所以对于希望保存文档的程序员来说，Github是一个不错的选择，尽管很多人只是利用代码库中的readme功能来为项目提供简单的 *** 作指南，但这并非是最好的办法。

ReadtheDocs。

顾名思义，ReadtheDocs为开发人员提供了一个集中的平台来保存文档，这样用户就可以直接阅读文档了。它的工作原理有点类似GitHubpages，因为开发人员可以从他们喜欢的版本控制系统（包括Git、Bazaar、Mercurial等）中推送文档更新。

能将复杂的业务描述清楚易懂，文档形式不限要能方便查阅。

原型图、流程图是少不了的，图形方便人理解。原型图不一定全要有交互效果，但关键部分、易忽略部分还是需要的。流程图特别能体现一个人的逻辑思维、系统思维以及严谨程度。

规范化的文字性文档。清晰准确的描述问题，内容前后一致，各种关系说明得逻辑严谨，各种业务术语，规范、统一且有备注。

规范的事情当然要有专业的工具。推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

一、请求参数

1. 请求方法

GET

用于获取数据

POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

DELETE

用于删除数据

其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

application/x-www-form-urlencoded

请求参数使用“&”符号连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：

二、响应参数

1. 响应 HTTP Body

响应body同请求body一样，需要描述请清除数据的类型。

另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。

三、接口说明

说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。

四、示例

上个示例（重点都用红笔圈出来，记牢了）：

五、接口工具

推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

---