数据库表结构文档生成神器，提高开发效率~

一键生成数据库文档大利器！安利 ~ #

介绍 在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果表结构调整很快、文档维护基本上就跟不上，就是一阵头痛，

利益关系人范围 数据库开发人员、后台管理人员、运维、测试等。

一、问题 1. 数据库表结构变更频繁，开发人员修改了数据库，运维人员并不知情，上线后报错，导致线上事故； 2. 数据库表结构文档没有及时更新，运维开发需要上线运维的时候，发现文档里写的字段，与线上实际不一致，导致运维很痛苦； 3. 数据库表结构文档编写格式不统一，各项目间协同开发很困难。

二、原因 1. 很少有开发人员愿意去写表结构文档，太繁琐了； 2. 文档更新一般是手工执行的，需要人为输入，并且可能因为疏忽或其他原因忘记更新文档； 3. 企业没有系统规范的文档编写流程，导致大家不知道该怎么写，无从下手；

三、工具调研 市面上，有几种工具可以协助我们生成数据库表结构文档，

第一种 TablePlus 优点：轻量级，不需要引入任何第三方模块； 缺点：作为一款付费软件，功能有限，不能满足快速发布的要求；

第二种 docsify 优点：是一个开源的文档工具，支持多语言、主题自定义、支持Markdown语法、简洁大方； 缺点：只支持静态页面，不支持动态的数据请求，如果表结构发生变更，文档需要手动同步；

第三种 mkdocs 优点：是一款强大的文档生成工具，支持Markdown语法、多语言、主题自定义、插件扩展等功能， 缺点：同样是静态页面，不支持动态的数据请求；

四、介绍一款重磅工具，很香~ dumi 优点：强大且免费的文档生成工具，不仅支持 Markdown 语法、多语言，还支持组件开发、数据可视化、代码示例，还内置了代码高亮、图片缩放等功能，支持代码块主题自定义，具有良好的代码演示效果。 缺点：对自定义化组件要求很高，容易踩坑

工具使用 本节将介绍如何使用 dumi 生成数据库表结构文档。 1. 安装 dumi npm install dumi -g 2. 创建项目 dumi create my-docs 3. 进入项目 cd my-docs 4. 启动项目 dumi start 5. 打开浏览器，访问 http://localhost:8000 查看文档

五、补充知识点 dumi 生成的文档是静态页面，如果表结构发生变更，文档需要手动同步。 为了解决这个问题，可以结合自动化的工具来实现文档的自动更新。 比如，可以使用 Jenkins 定时构建项目，并自动将构建后的文档发布到服务器上。这样，每次表结构发生变更后，Jenkins 都会自动触发构建任务，并自动更新文档。 结合 GitLab 来做文档自动构建，效果更佳。

六、如何处理图片上传 可以使用第三方工具来实现图片上传。 比如，可以使用七牛云、又拍云等云存储服务来存储图片。 也可以使用 GitHub 来存储图片。 然后，在文档中使用 Markdown 语法来引用图片。

优点 1. 可以提高开发人员的生产效率，减少编写文档的时间； 2. 可以保证文档的及时性和准确性，避免由于人为疏忽而导致的文档错误； 3. 可以统一文档的编写格式，提高文档的质量和可读性； 4. 可以方便地将文档发布到网上，方便团队成员和用户访问。

结论 使用自动化的工具来生成数据库表结构文档，可以提高开发人员的生产效率，保证文档的及时性和准确性，统一文档的编写格式，提高文档的质量和可读性，方便地将文档发布到网上，方便团队成员和用户访问。