9、软件开发文档与架构设计全解析

软件开发文档与架构设计全解析

1. 开发视角文档

在构建大型系统时，若系统包含众多模块，就需要对代码进行结构化处理，遵循系统级的设计约束，或者在系统各部分之间共享一些通用方面。从开发视角呈现解决方案，对软件开发人员和测试人员都有益处。

开发视角的包图能清晰展示系统中不同模块的位置、它们之间的依赖关系以及其他相关模块（例如位于同一软件层的模块）。它不一定非得是 UML 图，简单的方框和线条也能满足需求。若计划让某个模块可替换，这种图能显示出哪些其他软件包会受到影响。

以下是开发视角文档的一些关键策略：
- 提高系统复用性 ：比如为组件创建自己的运行时框架。
- 增强系统连贯性 ：采用通用的认证、日志记录、国际化或其他处理方法。
- 代码组织、构建和配置管理 ：采用通用的方法并记录下来。若要记录的内容过多，可聚焦于最重要的部分，其他部分简要提及即可。

2. 部署和操作视角文档

若部署环境非标准或复杂，例如在硬件、第三方软件或网络要求方面有特定需求，可考虑为系统管理员、开发人员和测试人员单独撰写部署部分的文档。

需要涵盖的内容如下：
| 类别 | 具体内容 |
| ---- | ---- |
| 硬件资源 | 所需内存量、CPU 线程数（是否支持超线程）、与 NUMA 节点的关联和亲和性 |
| 网络设备 | 专业网络设备要求，如用于测量延迟和吞吐量的标记数据包的交换机、网络拓扑结构、估计所需带宽 |
| 存储 | 应用程序的存储要