数据库文档编写流程

在一个系统中新增一个模块,通常不是一个人能够独立完成的。这需要多个团队甚至两个组的共同合作。例如,如果我们想在设备管理系统中添加一个IT资产管理模块,领导不会简单地说:“喂,你给我加一个IT资产管理模块。”直接这样告诉我,我肯定会感到无从下手,因为没有具体的指导和信息。

一般情况下,基础架构组会先详细列出IT资产管理模块的功能清单。

每个功能需要创建哪些数据库表,每张表的具体字段。

每个功能的预期效果。

以及页面的布局等信息,都会详细地提供给我们。

只有在拿到这些详细信息之后,我们才能开始着手进行开发工作。

如何开发呢?

第一步是编写数据库文档。你需要对照领导提供的资料,搞清楚每一张表的作用是什么、存储的是什么数据。如果有不明白的地方,就去找涛哥,让他解释每张表的具体功能和用途。弄明白每张表的作用之后,你就可以一张表一张表地开始编写数据库文档。

这一步完成后,其实只是写了一个大概,还没有完全写完。接下来,你需要思考表与表之间的关联。如果有关系,你应该通过添加某个字段来将两张表关联起来(例如,在这张表中添加一个 task_id 字段,使 task_id 与另一张表的 id 相关联,从而实现两张表的关联)。

完成这一步后,下一步是为每张表添加 create_bycreate_timeupdate_byupdate_time 和 delete_flag 这五个字段(虽然不一定每张表都需要,但大部分表通常都会有这些字段,我们一般习惯将它们加上)。

完成前几步后,你就可以根据编写好的数据库文档,将其中所有的表导入到你的数据库中。接下来,使用 Navicat 等工具自动生成表关系图。通过这些步骤,数据库文档就彻底完成了。

——————————————————————————————————————————

2024.10.12

今天,睿哥在检查我的数据库文档时,发现了一些错误。睿哥跟我讲,IT设备信息表可以复用设备基础信息表(device_baseInfo),这意味着当我创建IT设备信息表时,只需要添加设备基础信息表中没有的字段即可。这两张表通过设备ID字段进行关联,从而实现对设备基础信息表的复用。同样,领用记录表和维修记录表也可以通过设备ID字段与设备基础信息表关联,实现信息的复用。

猜你喜欢

转载自blog.csdn.net/qq_54432917/article/details/142856833