confluence文档经验总结

这周公司的事情太忙了，一直在写文档，验收，审核，看规范。分享一下我们实习组的经过两次被验收，总结出来的经验。（个人经验，仅供参考）

（一）写文档前必看规则

核心内容
1.从swagger中查出内容之后，必须先复制到json字符串在线格式化工具，检查一下格式，再粘贴。

格式问题
2.ER图如果是上下的，关系写的时候也要按照对应关系写成上下的。

3.流程图：画的是后端图，从前端出发一个请求开始，一直到后端的判断和逻辑。

（二）文档规范

（1）数据库设计图开发注意事项

核心内容
1.严格按照数据库设计图模板来画

格式问题
2.表清单代表二级模块功能中用到的所有表，表结构的内容是从咱们的navicat数据库中得来。

3.格式要规范，记得设置几级模块。

（2）页面UE展示、流程、接口图模板开发注意事项

核心内容

1.图中的流程框里要写上在从前端触发了那个请求，后端逻辑怎样走的：
(根据什么字段？)从什么表里（左连接了哪些表）查询了什么字段。返回了什么。
是否有逻辑判断，逻辑判断之后又是什么。

格式问题

1.第一部分放一张UE图，代表文档中的内容均出自此图。

2.第二部分是各功能流程接口图，一个功能包括流程图和接口图。先画流程图，再画接口图。

3.流程图是严格按照后端的方法来画，假如一个功能走了两个后端的方法，那么这个功能就需要画两个流程图，同理下面也应该接有两个接口图

4.流程图需要注意图标，返回的状态码(后端定义的状态码)，

5.统一使用ProcessOn工具来画图，画好的图要保留原件，整理到文档时要使用ProcessOn里的导出图片功能，导出为png格式

6.接口图：首先，方法描述要写的清晰，点击哪里？执行什么效果？

7.接口图的请求URL最后要有参数，中间用&隔开，

8.表格中必须要有表头，表头背景色要突出，注意表头列的顺序不要更改

9.请求参数和返回参数的类型及注释均是从对应的后端方法中entity类中查到的。不允许自己命名，如果entity只有声明，没有中文注释，我们也不需要表格中写上注释

总结：加油吧~