体系结构设计报告模版

体系架构设计报告模板体系架构设计报告模板 Version 1 0 体系结构设计报告 Page 2 of 7 变更记录变更记录 版本号版本号变更日期变更日期修订人修订人变更原因变更原因评审日期评审日期评审人评审人 体系结构设计报告 Page 3 of 7 目目目 录录录 1 系统概述系统概述 4 2 设计约束设计约束 4 3 设计策略设计策略 4 4 系统总体结构系统总体结构 4 5 子系统子系统 N 的结构与功能的结构与功能 5 6 开发环境的配置开发环境的配置 5 7 运行环境的配置运行环境的配置 5 8 测试环境的配置测试环境的配置 5 9 其他其他 5 体系结构设计报告 Page 4 of 7 1 系统概述系统概述 提示 提示 1 说明本系统 是什么 2 描述本系统的主要功能 2 设计约束设计约束 提示 提示 1 需求约束 体系结构设计人员从需求文档 如 用户需求说明书 和 软件需求规格 说明书 中提取需求约束 例如 本系统应当遵循的标准或规范 软件 硬件环境 包括运行环境和开发环境 的约束 接口 协议的约束 用户界面的约束 软件质量的约束 如正确性 健壮性 可靠性 效率 性能 易用性 清晰性 安全性 可扩展性 兼容性 可移植性等等 2 隐含约束 有一些假设或依赖并没有在需求文档中明确指出 但可能会对系统设计产 生影响 设计人员应当尽可能地在此处说明 例如对用户教育程度 计算机技能的一些假设 或依赖 对支撑本系统的软件硬件的假设或依赖等 3 设计策略设计策略 提示 提示 体系结构设计人员根据产品的需求与发展战略 确定设计策略 Design Strategy 例如 扩展策略 说明为了方便本系统在将来扩展功能 现在有什么措施 复用策略 说明本系统在当前以及将来的复用策略 折衷策略 说明当两个目标难以同时优化时如何折衷 例如 时 空 效率折衷 复杂性与实用性折衷 4 系统系统架构架构 提示 提示 1 将系统分解为若干子系统 绘制物理图和逻辑图 说明各子系统的主要功能 2 说明 如何 以及 为什么 how and why 如此分解系统 3 说明各子系统如何协调工作 从而实现原系统的功能 体系结构设计报告 Page 5 of 7 5 子系统子系统 N 的结构与功能的结构与功能 提示 提示 1 将子系统子系统 N N 分解为模块 Module 绘制逻辑图 如果物理图和逻辑图不一样的话 应 当绘制物理图 说明各模块的主要功能 2 说明 如何 以及 为什么 how and why 如此分解子系统子系统 N N 3 说明各模块如何协调工作 从而实现子系统子系统 N N 的功能 6 公共模块公共模块 提示 提示 1 在此定义公共模块 以及在系统总体架构中起的作用 定义出交互的接口 7 系统出错处理设计系统出错处理设计 7 1 出错信息出错信息 提示 提示 1 用一览表的方式说朗每种可能的出错或故障情况出现时 系统输出信息的形式 含意 及处理方法 序序 号号类别类别种类种类说明说明处理方法处理方法 1 错误 Error 2警告 Warning 3通知 Information 体系结构设计报告 Page 6 of 7 7 2 补救措施补救措施 提示 说明故障出现后可能采取的变通措施 包括 提示 说明故障出现后可能采取的变通措施 包括 1 后备技术说明准备采用的后备技术 当原始系统数据万一丢失时启用的副本的建立和 启动的技术 例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术 2 降效技术说明准备采用的后备技术 使用另一个效率稍低的系统或方法来求得所需结 果的某些部分 例如一个自动系统的降效技术可以是手工操作和数据的人工记录 3 恢复及再启动技术说明将使用的恢复再启动技术 使软件从故障点恢复执行或使软件 从头开始重新运行的方法 7 3 系统维护设计系统维护设计 提示 提示 1 说明为了系统维护的方便而在程序内部设计中作出的安排 包括在程序中专门安排用 于系统的检查与维护的检测点和专用模块 8 外部接口外部接口 8 1 用户接口用户接口 提示 提示 1 说明为了系统维护的方便而在程序内部设计中作出的安排 包括在程序中专门安排用 于系统的检查与维护的检测点和专用模块 8 2 软件接口软件接口 提示 提示 1 描述该软件与其它系统的软件接口 主要说明其它系统提供的编程接口和本系统向其 它系统提供的编程接口 如具有等同作用的文件 如包含接口说明及注释的源文件程序头文 件 接口帮助的超文本文件等 本处仅需列出该文件名 保管部门即可 8 3 其它接口其它接口 提示 提示 1 描述该软件与其它系统的其它类型接口 主要说明其它系统提供的和本系统向其它系 统提供的硬件接口 通信协议及规程 数据交换格式等 如具有等同作用的文件 本处仅需 体系结构设计报告 Page 7 of 7 列出该文件名 保管部门即可 9 开发环境的配置开发环境的配置 提示 提示 说明本系统应当在什么样的环境下开发 有什么强制要求和建议 类别标准配置最低配置 计算机硬件 软件 网络通信 其他 10 运行环境的配置运行环境的配置 提示 提示 说明本系统应当在什么样的环境下运行 有什么强制要求和建议 类别标准配置最低配置 计算机硬件 软件 网络通信 其他 11