详细的设计说明书模板.doc

TP-SRGS-QLJ-SJ-003 （内部保密资料） 详细设计说明书模板 自2008年 9月 10 日起正式生效 广州从兴电子开发有限公司 编制： 审批： 共 页 文档修改历史 日期 版本 作者 修改内容 评审号 变更控制号 发布日期 XXX-XXX-XXX-XXX-XXX （内部保密资料） 详细设计说明书 自 年 月 日起正式生效 广州从兴电子开发有限公司 编制： 审批： 共 页 文档修改历史 日期 版本 作者 修改内容 评审号 变更控制号 发布日期 [上表填写本过程文档的版本修改历史] 目录 1. 概述 4 1.1. 文档目的 4 1.2. 遵循原则 4 1.3. 术语 4 1.4. 参考资料 4 2. 系统周边环境 4 3. 系统架构设计 5 3.1. 软件架构设计 5 3.1.1. 总体说明 5 3.1.2. 部署设计 5 3.1.3. 优缺点 5 3.1.4. 环境要求 5 3.1.4.1. 运行环境 5 3.1.4.2. 开发环境 5 3.2. 应用架构设计 6 4. 功能设计 6 4.1. 功能1（名称用功能标识+地区标识+编号+功能名称） 6 5. 非功能性设计 6 5.1. 部署设计 6 5.2. 可用性设计 6 5.3. 安全性设计 7 5.4. 性能考虑 7 5.5. 其他设计 7 6. 其他说明 7 概述 文档目的 描述编写此设计说明书的目的 遵循原则 描述编写此设计说明书所遵循的相关原则（设计指南等） 术语 术语 解释 来源 其他 参考资料 文档编号 文档名称 版本 来源 系统周边环境 列出系统周边的相关系统，及周边系统的主要功能说明。可用图示表达 系统架构设计 软件架构设计 可贴图说明系统的软件架构 总体说明 对系统的总体介绍（架构的总体介绍） 部署设计 可贴图说明系统的安装部署设计 优缺点 列出3.1.2部署设计方案的优缺点 环境要求 运行环境 需求名称 详细要求 客户端PC机 数据库 中间件 MainFrame－OS 开发环境 项目 描述 要求 开发工具 开发服务器 数据库 应用架构设计 介绍系统的应用架构设计 接口设计 说明本系统同外界的所有接口的安排包括软件和硬件之间的接口、本系统与各支持软件之间的接口关系。主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等）。 功能1（名称用接口标识+地区标识+编号+功能名称） 接口描述 【在此描述该功能点完成的主要任务，说明是本系统接口还是外部接口，调用方是谁】 实现过程 【描述操作员与界面的操作，界面与后台逻辑的调用关系，必要时辅助RSA的时序图描述，涉及到的后台业务逻辑要按类进行划分，各个业务逻辑对应作为该类中的方法，每个界面和业务逻辑要进行编号，以便与界面设计和逻辑处理中的描述进行对应】 输入 【描述该功能点接收的参数或文件，以及输入的判断逻辑，以表格形式展现】 输出 【描述该功能点输出的参数或文件，以及输出的错误信息，以表格形式展现】 涉及的库表和类 【描述该功能点涉及的关键类和关键表信息】 功能设计 功能1（名称用功能标识+地区标识+编号+功能名称） 功能描述 【在此描述该功能点完成的主要任务】 业务实现流程 【描述操作员与界面的操作，界面与后台逻辑的调用关系，必要时辅助RSA的时序图描述，涉及到的后台业务逻辑要按类进行划分，各个业务逻辑对应作为该类中的方法，每个界面和业务逻辑要进行编号，以便与界面设计和逻辑处理中的描述进行对应】 输入输出说明 【重点描述输入输出项的作用，以及需要