数据库开发文档记录方法

一、引言

        最近因为项目需求变动原因，数据库已经改的面目全非，和自己最初设计的数据库至少查了十多个版本，基本跟推翻了一样。由于缺少原有的记录加上改的比较零碎，所以忘记了原来的表关系，发现将数据库中的表记录下来并实时更新还是很有必要的。

记录的程度很重要，记得详细了浪费时间主体关系不突出，记录的简单了有些东西表达不出来，所以综合了一下还是用mindmanager比较方便。下面展示下我的记录规则

二、方法

        一般系统里面无非三种主要数据：用户信息，管理本体信息，流程信息。

        按照三种数据分类，然后在各自信息中记录数据库中建的表格以及附属表格，同时可以下视图，或者按照需要记录下简单的存储过程也可以，这样就很一目了然的知道系统中基本数据信息，通过这些基本信息综合处理实现甲方的功能需求。

        除了数据库的开发文档记录，后台的也需要开发文档，这个用swagger记录就挺好的，方便快捷，而且最好按照本体信息将接口分类，最好不要按照功能模块分类，因为按照功能分类很有可能好多模块的功能会用到同一个接口，so你得写好几遍==

三、总结

• 数据库开发文档必要性

• 数据库开发文档方便快捷的记录要求

• 后台开发文档使用swagger，按照本体信息分类