详细设计说明书模板

TP-SRGS-QLJ-SJ-003（内部保密资料）详细设计说明书模板自2008年9月10日起正式生效广州从兴电子开发有限公司编制：审批：共页TP-SRGS-QLJ-SJ-003概要设计说明书模板文档修改历史日期版本作者修改内容评审号变更控制号发布日期XXX-XXX-XXX-XXX-XXX（内部保密资料）详细设计说明书自年月日起正式生效广州从兴电子开发有限公司编制：审批：共页XXX-XXX-XXX-XXX-XXX概要设计说明书文档修改历史日期版本作者修改内容评审号变更控制号发布日期[上表填写本过程文档的版本修改历史]XXX-XXX-XXX-XXX-XXX概要设计说明书广州从兴电子开发有限公司第5页共10页目录1.概述....................................................................................................................................................61.1.文档目的............................................................................................................................61.2.遵循原则............................................................................................................................61.3.术语....................................................................................................................................61.4.参考资料............................................................................................................................62.系统周边环境....................................................................................................................................63.系统架构设计....................................................................................................................................73.1.软件架构设计....................................................................................................................73.1.1.总体说明....................................................................................................................73.1.2.部署设计....................................................................................................................73.1.3.优缺点........................................................................................................................73.1.4.环境要求....................................................................................................................73.1.4.1.运行环境............................................................................................................73.1.4.2.开发环境............................................................................................................73.2.应用架构设计....................................................................................................................84.功能设计............................................................................................................................................84.1.功能1（名称用功能标识+地区标识+编号+功能名称）..............................................85.非功能性设计....................................................................................................................................95.1.部署设计............................................................................................................................95.2.可用性设计........................................................................................................................95.3.安全性设计........................................................................................................................95.4.性能考虑............................................................................................................................95.5.其他设计..........................................................................................................................106.其他说明..........................................................................................................................................10XXX-XXX-XXX-XXX-XXX概要设计说明书广州从兴电子开发有限公司第6页共10页1.概述1.1.文档目的描述编写此设计说明书的目的1.2.遵循原则描述编写此设计说明书所遵循的相关原则（设计指南等）1.3.术语术语解释来源其他1.4.参考资料文档编号文档名称版本来源2.系统周边环境列出系统周边的相关系统，及周边系统的主要功能说明。可用图示表达XXX-XXX-XXX-XXX-XXX概要设计说明书广州从兴电子开发有限公司第7页共10页3.系统架构设计3.1.软件架构设计可贴图说明系统的软件架构3.1.1.总体说明对系统的总体介绍（架构的总体介绍）3.1.2.部署设计可贴图说明系统的安装部署设计3.1.3.优缺点列出3.1.2部署设计方案的优缺点3.1.4.环境要求3.1.4.1.运行环境需求名称详细要求客户端PC机数据库中间件MainFrame－OS3.1.4.2.开发环境项目描述要求XXX-XXX-XXX-XXX-XXX概要设计说明书广州从兴电子开发有限公司第8页共10页开发工具开发服务器数据库3.2.应用架构设计介绍系统的应用架构设计4.接口设计说明本系统同外界的所有接口的安排包括软件和硬件之间的接口、本系统与各支持软件之间的接口关系。主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等）。4.1.功能1（名称用接口标识+地区标识+编号+功能名称）一、接口描述【在此描述该功能点完成的主要任务，说明是本系统接口还是外部接口，调用方是谁】二、实现过程【描述操作员与界面的操作，界面与后台逻辑的调用关系，必要时辅助RSA的时序图描述，涉及到的后台业务逻辑要按类进行划分，各个业务逻辑对应作为该类中的方法，每个界面和业务逻辑要进行编号，以便与界面设计和逻辑处理中的描述进行对应】三、输入【描述该功能点接收的参数或文件，以及输入的判断逻辑，以表格形式展现】四、输出【描述该功能点输出的参数或文件，以及输出的错误信息，以表格形式展现】五、涉及的库表和类【描述该功能点涉及的关键类和关键表信息】5.功能设计5.1.功能1（名称用功能标识+地区标识+编号+功能名称）一、功能描述【在此描述该功能点完成的主要任务】二、业务实现流程XXX-XXX-XXX-XXX-XXX概要设计说明书广州从兴电子开发有限公司第9页共10页【描述操作员与界面的操作，界面与后台逻辑的调用关系，必要时辅助RSA的时序图描述，涉及到的后台业务逻辑要按类进行划分，各个业务逻辑对应作为该类中的方法，每个界面和业务逻辑要进行编号，以便与界面设计和逻辑处理中的描述进行对应】三、输入输出说明【重点描述输入输出项的作用，以及需要注意的事宜】四、界面展现说明【描述该功能点包括的各个界面元素与特殊的界面要求，涉及到翻译参数的要与数据字典中的参数代码进行对应，同时对每个界面要定义代码项目中的目录位置和文件名称；要指出界面展现的字段及输入的参数】五、涉及的库表和类【描述该功能点涉及的关键类和关键表信息】六、细节描述【说明该环节中需要注意的事项，以及容易告成误解，难以理解，或者有争议的方面】6.非功能性设计6.1.部署设计描述功能设计中各个功能模块在网络拓扑上如何部署6.2.可用性设计可选：此处是针对系统可用性需求而进行的设计，包括使用的可用性标准，如公司或业界的界面设计原则标准、以及这些标准在系统中如何进行采用和体现等。6.3.安全性设计可选：此处给出网络级、操作系统级、应用级以及其它的关于安全性方面的设计。通常包含系统安全性、数据安全性等方面的应对策略及措施，一般涉及到系统和数据库的访问方式、数据的备份与