软件详细设计

研发生产中心文档编号版本A1密级商密A项目名称Xx系统项目来源QR-RD-022(Ver1.2)Xxx 系统详细设计说明书（内部资料 请勿外传）期：期：期：期：编检审批XX公司版权所有 不得复制文档变更记录序号变更（+/-）说明作者版本号日期批准12目录1. 引言 31.1编写目的和范围31.2术语表31.3参考资料31.4使用的文字处理和绘图工具32. 全局数据结构说明32.1常量32.2变量42.3数据结构43. 模块设计43.1用例图43.2功能设计说明43.2.1 模块 143.2.2 模块 254. 接口设计64.1内部接口64.2外部接口6接口说明6调用方式65. 数据库设计66. 系统安全保密设计66.1说明66.2设计7数据传输部分76.2.2 IP过滤分部7身份验证部分77. 系统性能设计7&系统出错处理71. 引言1.1 编写目的和范围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑包，括程序描述、输入/输出、 算法和流程逻辑等，为软件编程和系统维护提供基础本。说明书的预期读者为系统设计人员 软件开发人员、软件测试人员和项目评审人员。1.2 术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。序号术语或缩略语说明性定义1PMProject Manager,项目经理21.3 参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括a.需求说明书、架构设计说明书等；b本项目的其他已发表的文件；c引用文件、资料、软件开发标准等。资料名称作者文件编号、版本资料存放地点1.4 使用的文字处理和绘图工具文字处理软件：编写设计文档使用的文字处理软件，如edOffice 绘图工具：使用的UML工具，如Rose、Jude、Visio2. 全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1 常量包括数据文件名称及其所在目录，功能说明，具体常量说明等。2.2 变量本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.3 数据结构包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。3. 模块设计3.1 用例图3.2 功能设计说明3.2.1 模块1模块1主要分为以下几个子模块：子模块、子模块2和子模块N。子模块 13.2.1.1.1 设计图3.2.1.1.2 功能描述简要描述子模块1 的业务功能。3.2.1.1.3 输入数据详细描述用户输入的数据（包括任何输入设备）以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.1.1.4 输出数据详细描述子功能1 所产生的数据以及这些数据的表现形式。3.2.1.1.5 业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.1.1.6 数据设计给出本程序中的局部数据结构说明包，括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体说明需要以文件方式保 存的数据文件名、数据存储格式、数据项及属性等）。3.2.1.1.7 源程序文件说明给出本程序的各源程序文件的说明包，括源程序文件名称及其所在目录功，能说明，包 含的前导文件及函数名称等。3.2.1.1.8 函数说明具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局 变量，局部变量，返回值，算法说明，使用约束等。3.2.1.1.9 限制条件3.2.1.1.10 其他说明模块2模块1主要分为以下几个子模块：子模块、子模块2和子模块N。子模块 13.2.2.1.1 设计图3.2.2.1.2 功能描述简要描述子模块1 的业务功能。3.2.2.1.3 输入数据详细描述用户输入的数据（包括任何输入设备）以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.2.1.4 输出数据详细描述子功能1 所产生的数据以及这些数据的表现形式。3.2.2.1.5 业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.2.1.6 数据设计给出本程序中的局部数据结构说明包，括数据结构名称，功能说明，具体数据结构说明 （定义、注释设计、取值）等。相关数据库表，数据存储设计（具体说明需要以文件方式保 存的数据文件名、数据存储格式、数据项及属性等）。3.2.2.1.7 源程序文件说明给出本程序的各源程序文件的说明包，括源程序文件名称及其所在目录功，能说明，包 含的前导文件及函数名称等。3.2.2.1.8 函数说明具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局 变量，局部变量，返回值，算法说明，使用约束等。3.2.2.1.9 限制条件3.2.2.1.10 其他说明4. 接口设计4.1 内部接口4.2 外部接口4.2.1 接口说明例如：XX子系统通过XX从XX子系统取得XX等，相关标准，调用示例，可根据需要增 加章节描述接口。4.2.2 调用方式例如：内部接口调用：例:/*通过用户服务号码取得该客户认证密码等信息，如果该客户存在返回0为，其他情况 参考错误编码*/public RUserInfo getUserInfo (String userNo);5. 数据库设计详见XXX数据库设计说明书如果数据库设计内容比较少，则直接在此处描述。6. 系统安全保密设计6.1 说明例如：由于存在与外部系统的接口,所以需要考虑访问安全的问题.6.2 设计例如：分为数据传输部分IP过滤部分身份验证部分章节可补充6.2.1 数据传输部分例如：在部分数据传递的时候考虑以https协议,需要在部署的时候作相关处理6.2.2 IP 过滤分部例如：可在系统前端通过?ilter实现该Filter实现对该地址访问的EP过滤作用可 信任IP地址通过xml文件进行配置6.2.3 身份验证部分例如：对信任的用户,颁发身份验证码,通过该标识进行身份识别.7. 系统性能设计8. 系统出错处理例如：为了在系统出现异常情况下给用户以明确的提示，可采用两种方式予以提示1. 使用Javascript的alert()函数直接提示，这主要在输入或修改的情况下使用；2. 使用统一的错误界面提示，该界面对应于Trorpage.jsp页面。错误界面样式如下 图所示：错误提示界面