每一个项目都 必须 包含一个 readme.txt 文件，readme 里书写这个项目的简单信息。作用主要有两个，一个是团队新成员可从此文件中快速获悉项目大致情况，另一个是部署项目时可以作为参考。

文档页面排版 必须 遵循 中文文案排版标准 ，在此基础上：

中文文档请使用全角标点符号；

“项目概述”- 介绍说明项目的一些情况，类似于简单的产品说明，简单的功能描述，项目相关链接等，500 字以内；

“开发环境部署 / 安装”- 一步一步引导说明，保证项目新成员能最快速的，没有歧义的部署好开发环境；

“服务器架构说明”- 最好能有服务器架构图，从用户浏览器请求开始，包括后端缓存服务使用等都描述清楚（主要体现为软件的使用），配合“运行环境”区块内容，可作为线上环境部署的依据；

“扩展包说明”- 表格列出所有使用的扩展包，还有在哪些业务逻辑或者用例中使用了此扩展包；

“自定义命令列表”- 以表格形式罗列出所有自定义的命令，说明用途，指出调用场景；

“接口列表”- 以表格形式罗列出项目所有接口，说明用途，指出调用场景。

点击图标链接注册，可享受官方赞助和优惠!