系统概要设计说明书-模板

1、-. z.概要设计说明书V.*文档状态：文档标识：*-SD- 草稿 正式发布 修改编撰：编撰日期：级别：文档版本：*-. z.修订历史记录日期版本说明作者-. z.目录 TOC o 1-3 h z u HYPERLINK l _Toc2926406861引言 PAGEREF _Toc292640686 h 1HYPERLINK l _Toc2926406871.1编写目的 PAGEREF _Toc292640687 h 1HYPERLINK l _Toc2926406881.2背景 PAGEREF _Toc292640688 h 1HYPERLINK l _Toc2926406891.3定义

2、PAGEREF _Toc292640689 h 1HYPERLINK l _Toc2926406901.4参考资料 PAGEREF _Toc292640690 h 1HYPERLINK l _Toc2926406912设计概要 PAGEREF _Toc292640691 h 1HYPERLINK l _Toc2926406922.1设计围 PAGEREF _Toc292640692 h 1HYPERLINK l _Toc2926406932.2设计目标 PAGEREF _Toc292640693 h 1HYPERLINK l _Toc2926406942.3设计原则 PAGEREF _Toc2

3、92640694 h 1HYPERLINK l _Toc2926406953架构设计 PAGEREF _Toc292640695 h 2HYPERLINK l _Toc2926406963.1概述 PAGEREF _Toc292640696 h 2HYPERLINK l _Toc2926406973.2系统边界 PAGEREF _Toc292640697 h 2HYPERLINK l _Toc2926406983.3系统架构 PAGEREF _Toc292640698 h 2HYPERLINK l _Toc2926406993.4功能架构 PAGEREF _Toc292640699 h 2HY

4、PERLINK l _Toc2926407003.5技术架构 PAGEREF _Toc292640700 h 2HYPERLINK l _Toc2926407013.6部署架构及软硬件配置 PAGEREF _Toc292640701 h 2HYPERLINK l _Toc292640702 部署架构 PAGEREF _Toc292640702 h 2HYPERLINK l _Toc292640703 硬件配置方案 PAGEREF _Toc292640703 h 2HYPERLINK l _Toc292640704 软件配置方案 PAGEREF _Toc292640704 h 2HYPERLIN

5、K l _Toc2926407054功能设计 PAGEREF _Toc292640705 h 3HYPERLINK l _Toc2926407064.1模块1设计说明 PAGEREF _Toc292640706 h 3HYPERLINK l _Toc292640707 模块描述 PAGEREF _Toc292640707 h 3HYPERLINK l _Toc292640708 功能说明 PAGEREF _Toc292640708 h 3HYPERLINK l _Toc292640709 流程描述 PAGEREF _Toc292640709 h 3HYPERLINK l _Toc2926407

6、10 相关算法 PAGEREF _Toc292640710 h 4HYPERLINK l _Toc292640711 性能 PAGEREF _Toc292640711 h 4HYPERLINK l _Toc292640712 限制条件 PAGEREF _Toc292640712 h 4HYPERLINK l _Toc292640713 尚未解决的问题 PAGEREF _Toc292640713 h 4HYPERLINK l _Toc2926407145权限设计 PAGEREF _Toc292640714 h 4HYPERLINK l _Toc2926407156外部接口设计 PAGEREF _

7、Toc292640715 h 5HYPERLINK l _Toc2926407166.1*接口 PAGEREF _Toc292640716 h 5HYPERLINK l _Toc2926407177数据库设计 PAGEREF _Toc292640717 h 5HYPERLINK l _Toc2926407188非功能设计 PAGEREF _Toc292640718 h 5HYPERLINK l _Toc2926407198.1性能设计 PAGEREF _Toc292640719 h 5HYPERLINK l _Toc2926407208.2事务处理PAGEREF _Toc292640720 h

8、 6HYPERLINK l _Toc2926407218.3错误处理 PAGEREF _Toc292640721 h 6HYPERLINK l _Toc2926407228.4日志处理和日志分析 PAGEREF _Toc292640722 h 6HYPERLINK l _Toc2926407238.5平安设计 PAGEREF _Toc292640723 h 6HYPERLINK l _Toc2926407249信息定义 PAGEREF _Toc292640724 h 6HYPERLINK l _Toc29264072510风险管理 PAGEREF _Toc292640725 h 6HYPERL

9、INK l _Toc29264072610.1技术风险 PAGEREF _Toc292640726 h 6HYPERLINK l _Toc29264072711遵循标准与规 PAGEREF _Toc292640727 h 7-. z.引言编写目的说明编写这份设计说明书的目的，指出预期的读者。背景列出本工程的任务提出者、开发者、用户，提出的缘由，现状分析等定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。参考资料列出有关的参考资料。设计概要设计围说明本文档设计所包括的容，如功能、接口描述设计目标从通过本次设计能够解决那些问题，到达什么样的效果设计原则针对本工程说明系统设计所要遵循的相

10、应的原则，如标准化、模块化等，并做详细说明架构设计概述系统边界定义系统与其他系统间的功能、业务和数据边界系统架构用系统架构图描述本系统根本的构造，主要包括直接构成系统的各个组件。相对细致的描述各个组件之间和系统与系统之间的连接以及通信关系功能架构用功能构造图和文字的方式描述系统的主要功能以及功能之间的关系技术架构用技术架构图和文字的方式描述系统所采用的技术路线以及系统的分层构造关系部署架构及软硬件配置部署架构描述系统的拓扑构造，包括应用效劳器、数据库效劳器、数据交换效劳器等在物理上的拓扑构造。硬件配置方案用列表的形式说明系统的硬件需求，主要包括硬件的详细配置，用途、数量软件配置方案用列表的形式

11、说明系统的软件需求，主要包括软件的详细配置，用途、数量功能设计模块1设计说明从本章开场，逐个地给出各个层次中的每个模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比拟低的模块或子程序，其很多条目的容往往与它所隶属的上一层模块的对应条目的容一样，在这种情况下，只要简单地说明这几点即可。模块描述给出对该模块的根本描述，主要说明设计本模块对应的主要需求，建立目的意义、建立的主要容、模块的特点等功能说明说明该根本模块应具有的功能,用列表的形式列出该模块的主要的功能点，并描述各个功能点的简要说明如下列图所示：状态评价方案管理PM00001实现状态评价方案的查询，修改，删除等

12、功能流程描述用图表辅以必要的说明来表示本模块的逻辑流程，可以用Visio绘制流程图、或者用活动图等图形形式来描述，也可以使用UML工具构建该局部需要按照模块业务流程进展详细描述相关算法对于使用到特殊或者复杂算法，应具体的说明算法的计算公式及计算步骤，以及实现的方式等性能功能点ID预计最大数据量响应时间要求性能瓶颈点解决该问题的关键技术点说明对该模块的性能要求，如定义多大的数据量下，该模块的响应时间，该性能的定义也将作为系统开发完成后的测试工程限制条件说明本模块在运行使用中所受到的限制条件。尚未解决的问题 说明在本程序的设计未解决而设计者认为在软件完成之前应解决的问题 权限设计表述角色定义，功能

13、权限、数据权限分组。外部接口设计*接口接口函数名：*(string str*接口频度：多长时间同步一次接口方式：采用哪种方式实现该接口，如webservices等，是手动或者自动同步参数str*：参数容说明返回值：返回值定义E*ception：返回的错误代码定义,可参见消息定义功能描述：功能描述接口字段名英文名长度类型必传容说明设备类型编码FeatureType 字符PAC该局部容可以为生成JavaDoc提供依据数据库设计【数据库设计容主要给出数据库的E-R图实例，并能生成数据库的建库脚本】非功能设计性能设计【描述我们可能遇到的慢的操作和查询以及任何提高他们的速度？我们所面临的大数据量的操作是什么？如果提高性能的策略？比方：建立数据库索引、数据分区、数据缓存等】事务处理【系统事务处理策略和方法】错误处理【如何处理应用系统和系统所产生的错误？如何校验用户的输入？如果显示错误提示？如果记录日志供系统管理员分析？如果防止系统的崩溃？】日志处理和日志分析【用户操作的日志如何处理？】平安设计 从物理设备、网络层的保护、操