大数据组项目文档整理方案

目录：

一、 项目文档规范说明

1. 文档结构说明

2. 案例说明

二、 项目文档结构说明

1. 文档结构步鄹：

2. 案例如下：

———————————————————————————————————

一、 项目文档规范说明

1. 文档结构说明

1) 流程图使用Visio画图

2) 其余资料使用MarkDown：只能有大标题、小标题和表格

2. 案例说明

1) MarkDown：大标题、小标题案例



2) MarkDown：表格案例

二、 项目文档结构说明

1. 文档结构步鄹：

1) 所有资料放在docs文件下面；

2) Docs下面的按照模块划分，比如：loyality、user_group_portrait、web_nginx；

3) 每个模块中只能包括：XXX业务流程图.vsdx，XXX业务流程及代码说明.md ，XXX业务维护说明.md

2. 案例如下：

1) Doc下面的按照模块划分



2) XXX业务流程图.vsdx，详细说明业务的执行步鄹



3) XXX业务流程及代码说明.md。其中包括：模块说明、 模块业务步鄹、模块代码说明、模块代码路径。（备注：标题一定要有，内容没有可以写“无”）



4) XXX业务维护说明.md，包括：建表语句、启动脚本路径及说明、Jar包路径、部署方式、更新方式、关闭方式、指标查询sql**（备注：标题一定要有，内容没有可以写“无”）**