也许是市面上最强的数据库文档管理工具了吧

背景

在软件行业，API 文档的自动化有着非常广泛而成熟的方案，但数据库模型文档的自动化却还是一片蓝海，我曾在网上搜寻良久，但并没有找到一款能同时满足我以下需求点的产品

1. 自动化：基于数据库自动生成文档
2. 版本化：文档历史版本回溯，版本差异对比
3. 团队化：适应不同团队结构，多样性功能为跨团队协作赋能
4. 个性化：给予使用者一定的文档定制能力

鉴于此，我利用业余的时间开发并开源了
这个项目，它专注于数据库文档的管理，核心能力就是上面提到的自动化、版本化、团队化和个性化四点。

如题，如果有更好的产品欢迎留言指出，给我一个奋斗的目标，当然这里也别忘点赞收藏一气呵成 ！

项目地址：https://github.com/vran-dev/databasir

文档地址：https://doc.databasir.com

问题

在进入正题之前，我想先聊一聊在数据库文档维护这个细分场景下，我们平时遇到的一些问题。

一、没有文档

这是最普遍的一个问题，没有人会否认文档对一个团队的价值，但文档的维护成本也经常让人望而却步

二、时间有限，这次就不写文档了

在人力、时间等资源都有限的情况下我们通常会暂时放弃文档的维护而优先完成业务目标（这本无可厚非），长此以往就会导致文档内容与业务模型之间的差异越来越大，即文档失真了。

三、百家齐放，格式标准不统一

每个人对文档的格式标准都有自己的想法，只是团队内部消化的话，大家的容忍度还是很高的，如果涉及跨团队协作的话，一个统一的格式标准能提高内容质量的最低下限。

四、失忆症，忘记补充文档

模型的变更 80% 的场景都是增量变化，比如加个字段、加一张表等，加了字段和表以后如果忘了更新文档就会造成前面提到的文档失真，但这非刻意为之，更类似于失忆症，根本原因与第二点不同。

现实中的问题远不止这些，但我们可以看看 Databasir 面对这些场景给出的答案，下面就进入 Show time 吧。

自动化，文档的事儿你不用