背景
为了保证团队开发文档的统一性、规范化，避免文档散落在各处(tapd、各云盘、本地文档等)，不方便查阅，特拟定此规范，用以规范文档的书写。
文档规范
- 统一在Gitlab各项目对应的Wiki上面书写开发文档
- 不要在Gitlab Wiki界面中直接编写文档，需要将Wiki(例如：accounting-center.wiki) clone到本地进行编写
- 使用markdown格式书写文档，推荐使用 Typora编辑器
- 文件名即是文档标题，文件名需要清晰，有意义
- 不要随意建目录，注意目录的分类、概括性，尽量不使用多层级目录
- Wiki首页(home.md)用于书写项目的全局信息、整体架构方案
- 每个目录下面必须有一个index.md索引文件，用于索引该目录下的所有文件
- 侧边栏页面(_sidebar.md)用于全部目录索引，每个目录必须在_sidebar.md建立一个索引链接
- 各链接不要带.md后缀，只需要文件名即可，否则会打开成一个md的原文件
- 附件资源放在uploads目录下，根据不同归类，可以新建不同的子目录
Gitlab Wiki 介绍
Gitlab中每个代码库有一个Wiki功能，可以方便的为项目编写相关的Wiki，并且提供了一个可视化编辑界面来编写文档。但是Gitlab的Wiki功能不够完善，文档之间的链接，上传的附件等，都不太好维护。如果没有好的组织管理，很容易导致Wiki最后杂乱无章。所以建议以git代码库的方式来管理Wiki。
注意：查看Wiki需要Guest级别的权限，创建和编辑Wiki页面需要Developer级别。
Gitlab提供了代码库的方式来管理Wiki，每个Wiki都是一个单独的Git仓库，与项目仓库相对应。例如：项目仓库accounting-center对应的Wiki仓库则为accounting-center.wiki。
clone 到本地
git clone ${代码仓库}.wiki.git然后就会看到一个${代码仓库}.wiki.git的空目录，接下来就可以在本地进行编写了，然后通过git提交管理。
目录结构
一个标准的wiki目录结构如下:
.
├── uploads/
├── 文档目录1/
├── 文档目录2/
├── _sidebar.md
└── home.md-
home.md： Wiki的首页，Gitlab左边菜单点击Wiki菜单项指向的就是此页面
-
_sidebar.md： Wiki页面的全局侧边栏，如果没有这个文件，Gitlab会有一套默认的侧边栏规则，展示Wiki所有的文档链接。一般我们需要重写此页面，按自己的规划建立好Wiki链接索引。
-
uploads：是Wiki的附件资源上传的路径。这个目录也是Gitlab中默认的附件上传路径，我们遵循这个规则，把附件都放这个目录，里面可以新建子目录。
-
文档目录1、文档目录2：自定义的文档目录，可以根据项目情况规划好目录分类、命名。