FieldDoc，这个小工具帮你 30 秒搞定数据库文档

先说痛点

做后端/实施/DBA 的，应该都遇到过这种场景：

项目要验收了，甲方说："把数据库设计文档给我一份，Word 格式。"

你打开数据库一看：几百张表，每张十几个字段，注释有的写了有的没写。你只能：

1. 打开数据库客户端
2. 对着每张表，把字段名、类型、长度、主键、允许空、注释一项项复制
3. 粘到 Word 里排版
4. 下一张表……

搞一下午，手都敲断了，还容易粘错行。更烦的是，下次表结构一变，还得重来一遍。

Navicat、DBeaver 这些工具自带导出，但试一下就知道——导出的格式乱七八糟，Excel 列宽不对、Word 没有表标题、注释还要自己补。

我之前一直这么凑合着用。直到去年实在忍不了了，用 .NET 自己写了个小工具，现在稳定用了一年多，分享出来。

这个小工具叫 FieldDoc

 

简单说，它干的事就一件：连接你的数据库，把所有表结构读出来，一键导出成 Excel / Word / Markdown。

支持六种数据库

SQL Server、MySQL、Oracle、PostgreSQL、MongoDB、SQLite。基本覆盖了常见项目里会遇到的库。

• SQL Server 默认 1433，MySQL 默认 3306，Oracle 默认 1521，选完类型端口自动切
• Oracle 支持选 Schema
• MongoDB 读集合结构
• SQLite 直接选文件，不用填服务器

我自己用 .NET 写的，WPF 桌面程序，单文件 exe，不用装 .NET 运行环境，双击就能跑。

三步出文档

第一步：填连接信息

选数据库类型，填服务器、库名、账号密码。点"测试连接"，通了就点"加载表结构"。

第二步：自动列出所有业务表

左边是表清单，点哪张表，右边显示字段明细：字段名、类型、长度、主键、允许空、默认值、注释。系统表、Oracle 内部表自动过滤。

第三步：导出

三个按钮：

• Word：交付客户、打印归档、项目验收
• Excel：技术评审、自己维护数据字典
• Markdown：丢 Git 仓库或 Confluence，开发同事随时看

导出的 Word 排版是排好的：封面、表清单（不带序号）、每张表一节、字段表等宽、表头加粗。打开直接能交。

 

导出的文档结构也简单：先一张表清单，然后每张表一节，字段明细一张表。

几个我自己觉得挺重要的点

1. 只读元数据，不碰业务数据

工具只读取表结构定义（字段名、类型、注释这些），绝不 select 任何一行业务数据。公司数据库密码不出本机，内网、涉密环境都能放心用。

2. 单文件 exe，不用装环境

打了单文件精简版，Windows 上双击就能跑。没装过 .NET 的开发机、实施现场机器都能用。

3. 中文注释不乱码

之前用脚本导出最烦的就是中文注释变 ??，这个工具编码全部按 UTF-8 处理，导出的 Word/Excel 中文注释直接可读。

4. 永久授权

一次付费终身用，不限数据库数量、不限表数量。一个授权码绑一台机器，换电脑找客服解绑就行。

举个实际例子

上周帮一个朋友看项目，SQL Server，230 多张表。填完连接信息，点"加载表结构"——3 秒全出来了。点"导出 Word"，打开就是一份排版整齐的文档，封面、表清单、每张表的字段明细，直接打印交付。

他之前用某数据库设计工具导出，配置半天还得学一遍怎么用。这个填完连接串就完事。

适合谁用

• 后端开发：交付项目时要交数据字典
• 实施工程师：客户现场部署完要出文档
• DBA：整理现有库结构
• 技术支持：接手老项目要快速了解表结构

不适合谁

• 要 ER 图、可视化建模的——那是 PowerDesigner / DataGrip 的事，这个工具只出文字版文档
• 要团队协作维护字典的——这是单人桌面工具，没有后端

顺便说一下另一个工具

写完这个文档导出工具之后，我又做了个配套的：SchemaDiff（库结构对比工具）。

主要解决"开发库和生产库表结构对不上"的问题——SQL Server / Oracle / MySQL / PostgreSQL 四种库，连接两个库自动对比表、字段、索引差异，3 分钟出报告。

两个工具配合用：对比完差异，顺手导出 Word 交付文档，一套流程下来不用在好几个工具之间切。

后面会单独写一篇讲 SchemaDiff，感兴趣可以关注下。

最后

工具是我一个人维护的，没团队，没客服电话，加 QQ / 微信我本人回。

下载地址：​​[下载链接]

免费版能试用前几张表的导出，觉得好用再考虑永久授权。有问题、想加功能，评论区或者直接加客服都行。