附录C 软件详细设计报告文档模板.docVIP

附录C 软件详细设计报告文档模板 1 引言 2 2 支撑环境 2 2.1数据库管理系统 2 2.2开发工具、中间件以及数据库接口 2 2.3 硬件环境 3 2.4 网络环境 3 3部件详细设计 3 3.1部件表格式 4 3.2界面表格式 5  1 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。 如果这份软件系统详细设计报告只与整个系统的某一部分有关系，那么只定义软件系统详细设计报告中说明的那个部分或子系统。 2 支撑环境 2.1数据库管理系统 描述数据库管理系统、以及安装配置情况，需要描述的内容可能包括： 产品名称以及发行厂商 这里的产品名称指的是数据库发行厂商发布产品时公布的正式商品名称，不应该 使用别名、简称、研发代号等非正式名称，以免混淆；同样的道理，发行厂商的 名称也应该使用正式名称。 版本号 数据库管理系统的准确版本号，必须按产品的实际情况描述到最细节的版本号。 补丁包版本号 描述实际上将要使用的数据库管理系统补丁包的版本号，必须注意，在某些情况 下该版本号不一定是最新的版本号。 安装位置 描述数据库管理系统的实际安装位置，应该分别对管理系统安缺位置和数据存放 位置进行描述，应该指明服务器名和安装卷号(盘号)。对于分布式数据库，必须 分别描述每一个数据库管理系统。 2.2开发工具、中间件以及数据库接口 描述所选用的工具软件和中间件的名称、版本号，以及开发工具与数据库或者中间件接口的情况。如果使用了多种开发工具、辅助开发工具、第三方软件部件、多种中间件、多种接口、等答应该逐项分别描述，并且说明每一项的适用范围。需要描述的内容可能包括： 产品名称以及发行厂商 同2.1中产品名称以及发行厂商。 版本号 同2.1中版本号。 补丁包版本号 同2.1中补丁包版本号。 数据库接口名称 描述数据库接口的名称，如果使用别名时，应同时描述使用的别名。 数据库接口方式 描述与数据库接口的方式，并说明该接口方式的特点；如果需要，还应该说明使 用时的注意事项。 2.3 硬件环境 描述所选用的硬件环境，各种机型，例如：服务器、工作站，应该分别描述。需要描述的内容可能包括： 机型； 主频； 内存容量； 磁盘容量； 特殊部件； 操作系统； 使用位置； 等等。 2.4 网络环境 描述可能影响应用软件访问数据库的各种网络环境，如果存在加密传输、VPN链路等情况，也必须描述。对于结构复杂的网络，还应该提供网络拓扑图和数据流向示意图。 3部件详细设计 这里所提及的软件部件，系指能够完成特定功能、相对独立的一些代码集合，它们可以是插件、组件、控件、函数、过程、子程序、动态连接库、等等。具体呈何种形态，取决于实际采用的开发工具和将要实现的软件结构。 按照合适的顺序，逐个描述软件部件的详细情况。描述的顺序可以是按层次横向进行描述，也可以是按模块纵向进行描述，总之描述的方式必须有利于读者理解软件结构。 每个部件采用一张软件部件表进行描述，软件部件表的格式见附表一，其中； 部件编号 软件部件的统一顺序编号；对于实行配置管理的软件开发项目来说，该编号必须 与该部件在配置管理中的编号相同。 部件名称 软件部件的正式英文名称，该名称是程序中使用的实际名称，必须符合国家相关软件命名标准。 所属子系统 指该部件所属的子系统； 对于不分为多个子系统的软件来说，不必填写该栏。 部件调用者 指调用该部件的部件(或界面参数)的编号和名称。 部件被调用者 指被该部件所调用的部件的编号和名称。 部件入口参数 指该部件入口数据类名称或者数据名称，以及对这些数据的描述； 如果部件没有入口参数，该栏为空。 部件出口参数 指该部件出口数据类名称或者数据名称，以及对这些数据的描述； 如果部件没有出口参数，该栏为空。 算法 指该部件的算法形式表示，如果很简单、或者不存在，也可以为空。 流程描述 指该部件的处理流程的详细表示或描述。 部件表示形式 指该部件完成开发后的最终表示形式，具体形式取决于开发工具和软件结构，表 示形式可能是： 插件、组件、控件， 函数、过程、子程序， 存储过程， 动态连接库， 等等。 运行环境 描述该部件所适合的运行环境，即说明该部件是针对何种运行环境所开发的； 可以直接描述运行环境，也可以描述运行环境的编号； 对于实行配置管理的软件开发项目来说，该描述必须与该部件在配置管理中的描 相同。 3