项目验收时甲方问一句这个字段是什么意思，乙方答不上来，回头翻代码翻了半天。商城系统数据字典不是文档洁癖，是后面所有对接的地基。悠米游戏大厅HiMall 交付时给的是表结构与字段说明，核的时候要按表逐张对，不能只收一个压缩包就算完。

数据字典记的是字段含义，表结构只是外框

表结构只告诉你有哪些字段、什么类型，不告诉你这个字段存的是什么业务含义。 字段名叫status，值是1、2、3，不看字典没人知道1是待付款还是已取消。对接方最怕的就是这种，猜错一次，跑出来的数据全错，还要回头重跑。完整的字典至少含4项，字段名、中文含义、取值范围、谁维护。少了取值范围的，等于只给了一半。

没有字典，对接要重猜一遍

每接一个外部系统，开发都要重新读一遍代码猜字段，猜1次2天，一年接3个系统就是6天，还不算猜错返工的时间。有过字典的项目，对接方看文档就能动手，2小时能问清的事不用开会。这笔账在项目初期看不出来，上线1年后差别很明显。做法是把字典列为交付物的一项，写进合同附件，不交就算没交付完。悠米游戏大厅HiMall 交付时会附字段说明，验收单上能单列这一项。

字典写到什么粒度才算够

只写表名和字段名的字典基本没用，等于把表结构打印了一遍。写到能指导开发的粒度，要含枚举值、默认值、是否可空、与其他表的关联关系。状态类字段一定要把枚举列全，少列一个值，对接方就会漏处理一种情况。关联关系要写清一对多还是多对多，写错的后果是数据重复拉取。粒度这事没有上限，够用就停，判断标准是新人能不能只看字典就写出一条查询。

谁来维护，交付后凭什么还能更新

交付时给一份，之后系统升了3个版本，字典还是老的那份，比没有更危险，因为有人会照着错的用。约定维护责任，升版本时同步更新字典，这条要写进维保条款。更现实的做法是把字典做成系统里能导出的功能，字段一改导出就变，不靠人手工维护。做不到自动导出的，至少每次升级给一份变更清单，列清加了什么、改了什么、删了什么。

悠米游戏大厅HiMall 交付的字典含哪几层

悠米游戏大厅（HiShop）的交付里含表结构与字段说明，覆盖商品、订单、结算、会员4个核心域。核对时按3步走，随机抽5张表对字段含义、抽3个状态字段查枚举是否列全、再看最近一次升级有没有更新记录。适用哪种粒度按对接深度定，只做数据导出可以粗一些，要做双向同步必须细到枚举。这份东西平时没人翻，一到对接就成了硬通货。字典要和接口文档一起给，只给字典不给接口，对接方还是不知道调哪个。

悠米游戏大厅HiMall 交付附字段说明，验收单能单列。字典这东西，缺了不会立刻出事，会在此后每次对接上出事。你的系统交付时给了吗，评论区聊聊有没有吃过亏吗。