架构设计项目说明书.doc

架构设计项目说明书 架构设计说明书 项目名称：[项目名称] 项目代号：[项目代号] 编制人：[编制人] 编制日期：[编制日期]  修订记录 版本 日期 撰写/修订人 备注/修订内容 目 录 TOC \o 架构设计说明书 1 1. 引言 5 1.1. 编写目的 5 1.2. 系统目标 5 1.3. 术语和缩写词定义 5 1.4. 参考资料 5 2. 需求规定 5 2.1. 系统功能 5 2.2. 系统性能 5 2.3. 故障处理要求 6 2.4. 软硬件要求 6 2.5. 其他需求限制条件 6 3. 总体结构设计 6 3.1. 系统体系结构 6 3.2. 系统开发的基础平台和关键组件 6 3.2.1. 外部基础平台和关键组件 6 3.2.2. 内部基础平台和关键组件 7 3.3. 总体结构 7 4. 子系统设计 7 4.1. 功能结构图/类图 7 4.2. 功能定义 7 4.3. 功能需求与系统模块的关系 8 5. 接口设计 8 5.1. 用户接口 8 5.2. 外部接口 8 5.3. 内部接口 8 6. 系统数据结构设计 8 6.1. 逻辑结构设计 9 6.2. 物理结构设计 9 6.3. 配置文件结构设计 9 6.4. 数据结构与程序的关系 9 7. 算法设计 9 8. 运行设计 9 8.1. 运行模块组合 10 8.2. 运行控制 10 8.3. 运行时间 10 9. 系统安全 10 9.1. 8.1 系统安全 10 9.2. 8.2 数据安全 10 9.3. 8.3 备份与恢复 10 9.4. 8.4 出错处理 11 10. 系统维护设计 11 11. 系统部署 11 11.1. 软硬件环境 11 11.2. 系统部署 11 11.3. 系统升级 11 12. 遗留问题 11 引言 编写目的 说明编写这份架构设计说明书的目的，指出预期的读者。 系统目标 本系统要达成的目标，应描述架构设计的细度及为下一步模块设计提供的支持。 术语和缩写词定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 参考资料 列出与本文密切相关的参考资料，可能包含如下内容： 本项目经核准的计划任务书或合同、上级主管的批文； 属于本项目的其它已发表的文件； 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明如何能够得到这些资料。 需求规定 说明影响架构设计的系统主要功能、输入输出、性能要求等的需求限制条件。 系统功能 系统的功能性需求，主要列出对架构设计产品影响的典型功能要求、数据要求、输入输出要求和界面要求等。 系统性能 主要包括 数据精度 执行效率 数据处理能力等的要求。 故障处理要求 系统出现故障时的处理机制，比如：故障转移等。 软硬件要求 软件需求规格中规定必须支持的软硬件环境。 其他需求限制条件 包括： 事先约定必须要使用的商业上架系统/组件（比如：必须在MS Office上做二次开发）； 必须应用的技术（比如：必须使用B/S结构）； 必须要与某商业软件做接口（比如：必须与用友软件做接口）； 与旧版本的兼容升级关系等 总体结构设计 系统体系结构 确定系统采用何种体系结构，如： 单机版还是网络版？ C/S结构还是B/S结构？ 两层结构还是多层结构？ 分布式数据库还是集中式数据库？ 分布式应用程序服务器还是集中式应用程序服务器？ 是采用.Net应用程序框架还是J2EE应用程序框架？ 系统开发的基础平台和关键组件 外部基础平台和关键组件 确定系统开发的外部基础平台和关键组件，如： 是在Windows平台、Unix平台或者Linux平台上开发？还是平台无关性？ 是否是在某些软件上作二次开发？如AutoCAD。 是否采用一些第三方的关键组件。 内部基础平台和关键组件 确定系统开发所使用的公司内部开发平台、组件/控件、公共函数/单元等公共资源，如： 是否在GSP平台上开发； 是否采用公司的报表控件； 是否复用公司其他产品的架构或资源等。 总体结构 给出系统结构总体框图（包括软件、硬件结构框图），说明本系统的各模块的划分，扼要说明每个系统模块的标识符和功能，分层次地给出各模块之间的控制与被控制关系。 如果采用结构化分析方法，通常采用下面两种模型来描述总体结构： 结构图（层次图）：对系统自顶向下进行分解。 系统流程图：描述子系统内部的控制流和数据流 如果采用面向对象的分析方法，通常采用包(package)图来描述总体结构。包(package)图描述了子系统之间的包含关系和依赖关系。 子系统设计 在总体结构设计中已经将系统划分为若干个子系统，在此需要对所有的子系统进行设