doc_specification.md

+# 用户文档编写规范
+
+
+## 基本原则
+1. 每个接口的文档应该具有相同的结构，结构参考 文档格式 
+2. 不同接口中相同的内容，以独立的md文件编写，在不同接口的md文件中引用
+
+## 文档格式
+
+每个功能的接口文档都大体由以下部分组成。其中公共的部分都在独立的md文件中编写，并在具体功能的md文件中引用。
+
+```
+## 文档标题 (使用二级标题，标题后跟分隔线)
+----
+
+文档功能基本描述
+
+{% include '../service_hosts_pub.md' %}
+
+
+### 调用路径
+> /interface/path
+
+### 输入参数
+具体输入参数的说明
+
+{% include './common/authenticate.md' %}
+
+### 输出结果
+
+#### 输出结果字段含义
+....
+
+{% include './common/error_code.md'%}
+
+
+```
+
+## 目录结构
+文档目录结构组织如下
+
+```
+├── dbp.wiki
+│   ├── common
+│   ├── example_response
+│   ├── example_source_code
+│   └── tables
+└── dbp.wiki
+    ├── common
+    ├── example_response
+    ├── example_source_code
+    └── tables
+```
+
+* common 存放共用的md文件
+* example_response 响应的json样例文件
+* example_source_code 样例代码文件
+* tables 表格对应的csv文件