1、概要设计说明书（V.XXX）文档状态：文档标识：XXX-SD- 草稿 正式发布 修改编 撰：编撰日期：保密级别：文档版本：xxxxx修订历史记录日期版本说明作者7目录1引言11.1编写目的11.2背景11.3定义11.4参考资料12设计概要12.1设计范围12.2设计目标12.3设计原则13架构设计23.1概述23.2系统边界23.3系统架构23.4功能架构23.5技术架构23.6部署架构及软硬件配置23.6.1 部署架构23.6.2 硬件配置方案23.6.3 软件配置方案24功能设计34.1模块1设计说明34.1.1 模块描述34.1.2 功能说明34.1.3 流程描述34.1.4 相关算法
2、44.1.5 性能44.1.6 限制条件44.1.7 尚未解决的问题45权限设计46外部接口设计56.1XXXX接口57数据库设计58非功能设计58.1性能设计58.2事务处理68.3错误处理68.4日志处理和日志分析68.5安全设计69信息定义610风险管理610.1技术风险611遵循标准与规范71 引言1.1 编写目的说明编写这份设计说明书的目的，指出预期的读者。1.2 背景列出本项目的任务提出者、开发者、用户，提出的缘由，现状分析等1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出有关的参考资料。2 设计概要2.1 设计范围说明本文档设计所包括的内
3、容，如功能、接口描述2.2 设计目标从通过本次设计能够解决那些问题，达到什么样的效果2.3 设计原则针对本项目说明系统设计所要遵循的相应的原则，如标准化、模块化等，并做详细说明3 架构设计3.1 概述3.2 系统边界定义系统与其他系统间的功能、业务和数据边界3.3 系统架构用系统架构图描述本系统基本的结构，主要包括直接构成系统的各个组件。相对细致的描述各个组件之间和系统与系统之间的连接以及通信关系3.4 功能架构用功能结构图和文字的方式描述系统的主要功能以及功能之间的关系3.5 技术架构用技术架构图和文字的方式描述系统所采用的技术路线以及系统的分层结构关系3.6 部署架构及软硬件配置3.6.1
4、 部署架构描述系统的拓扑结构，包括应用服务器、数据库服务器、数据交换服务器等在物理上的拓扑结构。3.6.2 硬件配置方案用列表的形式说明系统的硬件需求，主要包括硬件的详细配置，用途、数量3.6.3 软件配置方案用列表的形式说明系统的软件需求，主要包括软件的详细配置，用途、数量4 功能设计4.1 模块1设计说明从本章开始，逐个地给出各个层次中的每个模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这几点即可。4.1.1 模块描述给出对该模块的基本描述，主要
5、说明设计本模块对应的主要需求，建设目的意义、建设的主要内容、模块的特点等4.1.2 功能说明说明该基本模块应具有的功能,用列表的形式列出该模块的主要的功能点，并描述各个功能点的简要说明如下图所示：原型界面界面ID功能概述状态评价计划管理PM00001实现状态评价计划的查询，修改，删除等功能4.1.3 流程描述用图表辅以必要的说明来表示本模块的逻辑流程，可以用Visio绘制流程图、或者用活动图等图形形式来描述，也可以使用UML工具构建该部分需要按照模块业务流程进行详细描述4.1.4 相关算法对于使用到特殊或者复杂算法，应具体的说明算法的计算公式及计算步骤，以及实现的方式等4.1.5 性能功能点I
6、D预计最大数据量响应时间要求性能瓶颈点解决该问题的关键技术点说明对该模块的性能要求，如定义多大的数据量下，该模块的响应时间，该性能的定义也将作为系统开发完成后的测试项目4.1.6 限制条件说明本模块在运行使用中所受到的限制条件。4.1.7 尚未解决的问题 说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题 5 权限设计表述角色定义，功能权限、数据权限分组。6 外部接口设计6.1 XXXX接口接口函数名：XXXX(string strxxx）接口频度：多长时间同步一次接口方式：采用哪种方式实现该接口，如webservices等，是手动或者自动同步参数strxxx：参数内容说明返回
7、值：返回值定义Exception：返回的错误代码定义,可参见消息定义功能描述：功能描述接口字段名英文名长度类型必传内容说明设备类型编码FeatureType 字符PAC该部分内容可以为生成JavaDoc提供依据7 数据库设计【数据库设计内容主要给出数据库的E-R图实例，并能生成数据库的建库脚本】8 非功能设计8.1 性能设计【描述我们可能遇到的慢的操作和查询以及任何提高他们的速度？我们所面临的大数据量的操作是什么？如果提高性能的策略？（比如：建立数据库索引、数据分区、数据缓存）等】8.2 事务处理【系统事务处理策略和方法】8.3 错误处理【如何处理应用系统和系统所产生的错误？如何校验用户的输入
8、？如果显示错误提示？如果记录日志供系统管理员分析？如果防止系统的崩溃？】8.4 日志处理和日志分析【用户操作的日志如何处理？】8.5 安全设计 从物理设备、网络层的保护、操作系统的安全防护，数据的安全防护、应用层的安全防护五个方面分别阐述如何保障系统的安全运行9 信息定义消息ID消息类型消息内容参数说明I00001Info更新完成W00001WarningE00001Error在此处统一定义系统的消息提示信息，包括“信息”，“警告”，“错误”三种类型，并说明消息的内容和参数说明，各功能模块在使用的时候直接使用消息ID10 风险管理10.1 技术风险【描述我们的技术风险，比如说我们所使用的API的变化我们怎么面对？】11 遵循标准与规范
