文档化数据的目标是帮助用户找到数据、理解数据,并有信心使用数据。
但您无需记录所有内容。良好建模的数据通常是不言自明的。
“好的代码本身就是文档” 这句话包含了很多真理。您应该力求使用具有表现力和一致性的自描述性名称。名为“dbo”的数据库没有帮助,而“sales_prod”则更好,尤其是在还有一个“sales_dev”和“finance_prod”数据库的情况下。
因此,文档化始于命名事物,但它并没有止步于此。
使用数据库系统的显式层次结构来构建自上而下的文档
这样,用户将开始理解全局,并且能够自己浏览您的数据环境。
记录数据时应关注的内容
完整记录前 3 个级别(系统、数据库、架构)。重点记录最常用的前 10% 的表。建立一个流程,所有新表/视图/模型都应创建至少最少的文档(在创建过程中,文档化最容易)。
通常,仅对于数据产品或广泛使用的报表表,记录所有列才值得。但对于这些,您应该严格要求。如果一列不值得记录,则不应将其作为表的一部分。
在实践中,选择正确的词语可能很困难。我应该使用客户还是帐户还是公司还是用户还是站点? 每个人都理解我们在团队中使用的首字母缩略词吗?
为了应对这些挑战,理想情况下,您的文档系统应通过术语表为您提供支持,您可以在其中一次定义重要术语并在文档中引用它们。
提示
- 使用具有表现力和一致性的名称;
- 自上而下记录最常用的内容;
- 通常一句话就足够了;
- 使文档成为开发过程的一部分;
- 在业务术语表中使用 #definitions;