背景
在前期的项目交付过程中,需要开发人员准备很多文档给甲方,例如:系统设计文档、部署文档、数据库文档等,其中数据库在交付阶段已经稳定,准备文档更多是复制、黏贴的事情。随即便有了这个想法,开发一个工具方便后面的使用。目前该工具只支持MySQL数据库,后续会慢慢补充。如果在使用过程中出现任何报错或者有更好的建议,请在Issues中提出
体验
下载
在releases界面下载最新版程序,如果是Windows系统下载exe应用,其他平台请下载jar文件,使用java -jar dbDoc.jar
命令启动程序
使用
输入各项信息,后点击确定 实现文档导出,目前导出的文件格式为doc
。以MySQL自带的information_schema
为例,输出了每张表的关键信息
也可以调整文档格式为己所用。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。