README.md 整体包含三部分：标题、目录、正文。
README.md 文件与 src、doc 在同级目录。
标题为一级标题。
目录、正文、正文章节为二级标题 。
章节内小节为三级标题，加两个缩进。
# 标题
## 目录
## 正文## 1. 简介
### 2.1
#### 4.1.1
标题
包含所属项目、后端等。例如： 活动助手--后端
目录
点击目录定位到相应正文章节。
正文
包含：
1. 简介
2. 部署
3. 接口文档Swagger的连接地址
4. 架构
5. 安装说明
6. 项目结构
7. 用户使用说明
1. 简介
简单说明本项目的要给用户做的事情。例如：用于活动签到、统计活动缺勤情况；用于管理隐号拨打；用于财务报账等等。
2. 部署
介绍项目的部署情况。发布版本历史，包括版本、发布日期、标签、版本说明。
最新发布的版本放在最上面。
3. 接口文档
Swagger文档地址。
4. 架构
项目用到的框架依赖等技术。
5. 安装说明
.gitlab-ci.yml 文件连接项目安装部署说明。
此部分需要运维配合完成。
6. 项目结构
介绍项目内板块，项目文件夹的目录结构，只包含文件夹，不包含文件。简单介绍各主要模块的功能。
7. 用户使用说明
不同用户操作本系统的使用说明。可以做什么，怎么做，注意事项、使用限制，用户工作流程等。
附录：
1. GitLab 中编辑 Markdown 技巧：
http://note.youdao.com/noteshare?id=65bd2469c4ec2558a6bee7fad4c1c012
2. 实际项目中 README.md 展示（需要权限）：
http://git.allhome.com.cn/java/platform_fin_manage_system/tree/finance0.0.1#%E7%9B%AE%E5%BD%95