记录数据的目的是帮助用户找到它、理解它,并对其使用充满信心。
但您不需要记录一切。良好的数据模型通常是自我解释的。
“好的代码是自我文档的” 这句话包含了很多真理。您应该力求使用表达性、一致且具有自我描述性的名称。一个名为 “dbo” 的数据库没有帮助,“sales_prod” 更好,特别是如果还有 “sales_dev” 和 “finance_prod” 数据库。
因此,记录从命名事物开始,但不止于此。
使用数据库系统的显式层次结构构建自上而下的文档
这样,用户将开始理解整体情况,并将能够自行导航您的数据景观。
在记录数据时应该关注什么
完整记录前三个级别(系统、数据库、模式)。重点关注记录最常使用的10%的表。建立一个流程,所有新创建的表/视图/模型都应至少包含最小文档(在创建过程中,记录是最容易的)。
记录所有列通常仅适用于数据产品或广泛使用的报表表。但对于这些,你应该非常严谨。如果一个列不值得记录,那么它就不应该是表的一部分。
在实践中,选择合适的词语可能很困难。我应该提到 客户 还是 账户、公司、用户 还是 网站?我们团队使用的缩写词大家是否都理解?
为了应对这些挑战,你的文档系统理想情况下应提供词汇表支持,你可以在其中定义重要术语一次,并在文档中引用它们。
提示
- 使用表达性和一致的名称;
- 自顶向下记录最常用的;
- 通常一句话就足够了;
- 将文档作为开发过程的一部分;
- 在业务词汇表中使用 #定义;