架构设计说明书

架构设计说明书 编号：02-SADS架构设计说明书文件状态： 草稿 正式发布 正在修改项目名称：当前版本：X.Y作 者：完成日期：Year-Month-Day密 级：修订历史记录日期版本修订说明作者日/月/年x.x修订的详细信息说明姓名17/17/20061.1增加“数据结构设计”章节曾志明目 录0.模板说明40.1编写目的40.2适用范围40.3术语定义41.系统概述42.设计约束43.设计策略54.系统总体结构55.子系统N的结构与功能56.开发环境的配置57.运行环境的配置68.测试环境的配置69.其它6第iii页/总7页北京市海淀区学清路8号 科技财富中心7层, 邮编：100085电话: +86-10-82736655, 传真: +86-10-82734630-架构设计说明书 编号：02-SADS0. 模板说明0.1 编写目的本报告的主要目的：本报告相关流程活动0.2 适用范围本报告适用范围（角色、部门、岗位、人员）使用本报告的约束条件本报告不适用的领域0.3 术语定义列出本报告中所使用的所有术语和缩略语。可引用已有的数据字典，如没有则需要在此列出。例如：参见数据字典.doc术语列出在本报告中用到的关键词和专用词，并给出其含义；缩略语列出在本报告中用到的所有缩略语，并给出中英文全称；另外在正文中缩略语首次出现处要给出中英文全称。1. 系统概述提示：（1）说明本系统“是什么”，（2）描述本系统的主要功能。 2. 设计约束提示：（1）需求约束。体系结构设计人员从需求文档（如产品包需求说明书和设计需求规格说明书）中提取需求约束，例如：本系统应当遵循的标准或规范软件、硬件环境（包括运行环境和开发环境）的约束接口/协议的约束用户界面的约束软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。3. 设计策略提示：体系结构设计人员根据产品的需求与发展战略，确定设计策略（Design Strategy）。例如：扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。复用策略。说明本系统在当前以及将来的复用策略。折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时空”效率折衷，复杂性与实用性折衷。4. 系统总体结构提示： （1）将系统分解为若干子系统，绘制物理图和逻辑图，说明各子系统的主要功能。（2）说明“如何”以及“为什么”（how and why）如此分解系统。（3）说明各子系统如何协调工作，从而实现原系统的功能。5. 数据结构设计确定关键数据结构，粗略定义数据库表。对关键性的骨干数据库文件系统、数据库文件、数据库表进行描述，说明它们的结构、一般特征和之间关系。5.1 E-R图给出描述数据库结构的实体关系图。5.2 表的结构列出关键数据库表，描述其用途，说明每个表的索引、主键、外键和注释。详细描述每个数据项，包括名称、标识、类型、长度、精度、格式、值域、能否为空等信息。5.3 物理设计说明数据库大小、存储空间安排、访问数据的方式（顺序或随机等）方法等。5.4 安全设计说明数据库的安全策略，给出数据库操作的用户权限。5.5 出错处理说明出现数据处理时，系统应如何进行处理。如：n 所有模块在运行中出错时，均需进行数据库操作的回滚，并正常断开与数据库的连接；n 系统运行需要记录运行日志，出错需要正确记录出错日志，可以将这些信息放在同一个日志文件中；n 需要将程序运行的关键步骤记录到日志中，便于程序运行情况的检查和维护；6. 子系统N的结构与功能提示： （1）将子系统N分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。（2）说明“如何”以及“为什么”（how and why）如此分解子系统N。（3）说明各模块如何协调工作，从而实现子系统N的功能。（3）说明各模块对其它模块的主要接口。7. 开发环境的配置提示：说明本系统应当在什么样的环境下开发，有什么强制要求和建议？类别标准配置最低配置计算机硬件软件网络通信其它8. 运行环境的配置提示：说明本系统应当在什么样的环境下运行，有什么强制要求和建议？类别标准配置最低配置计算机硬件软件网络通信其它9. 测试环境的配置提示：说明本系统应当在什么样的环境下测试，有什么强制要求和建议？（1）一般地，单元测试、集成测试环境与开发环境相同。（2）一般地，系统测试、用户测试环境与运行环境相同或相似（更加严格）。10. 其它提示：其它任何有必要在本文档中说明的信息；如果放在“其它”标题下不够醒目，可以另起标题；并通知产品研发流程小组，考虑是否对本文档进行修订。第7页/总7页北京市海淀区学清路8号 科技财富中心7层, 邮编：100085电话: +86-10-82736655, 传真: +86-10-82734630