返回介绍

第 56 章 数据

发布于 2024-08-18 00:06:34 字数 697 浏览 0 评论 0 收藏 0

一个软件系统相关的数据通常不是主要关注点,却可以说比软件本身更重要,所以对它做一些文档常常是有用的。

意图

数据部分的目的是记录任何从数据的角度来看重要的东西,回答下面几类问题。

数据模型看起来是什么样?

数据存储在哪里?

谁拥有数据?

数据需要多少存储空间?(比如,特别是如果你在处理“大数据”。)

归档和备份策略是什么?

业务数据的长期归档是否有法规要求?

日志文件和审计跟踪是否有类似的要求?

是否用简单文件来存储?如果是,用的是哪种格式?

结构

一个短小的部分包含你要描述的每个元素,保持简单;如果对读者有帮助,再包含域模型或实体关系图。就像我在代码部分的包含类图的建议,让任何图都停留在较高的抽象层次,而不是包含每一个字段和属性。如果有人需要这类信息,(举个例子)他们可以在代码或数据库中找到。

56.3 动机

写这个部分的动机是大多数软件系统的数据往往比软件存在得更久。这个部分可以帮助任何需要持续维护和支持数据的人,再加上任何需要在数据上提取报表或进行商业智能活动的人。软件系统在将来不可避免地要重写,这个部分还可以作为一个起点。

受众

主要是软件开发团队中的技术人员以及其他可以协助部署、支持和运营软件系统的人。

是否必须

不是,但除了不重要的软件系统,我通常都会包含这个部分。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文