还剩5页未读,继续阅读
文本内容:
软件详细设计报告文档模板
1.弓I言2编写目的
1.12项目风险
1.22文档约定
1.32预期读者和阅读建议
1.43参考资料
1.
532.支撑环境3数据库管理系统
2.13开发工具、中间件以及数据库接口
2.23硬件环境
2.34网络环境
2.44多种支撑环境开发要点
2.
543.部件详细设计
44.词汇表
65.部件表格式
66.界面表格式7引言
1.本详细设计报告主要帮助预期读者对象,熟悉和了解这份文档所编写目的、存在风险及产品范围等编写目的
1.1本说明书是在概要设计的基础上编制,它将为下一阶段的程序编码工作提供依据,它将作为项目验收的重要内容和后期维护的必备资料项目风险
1.2软件开发项目的主要风险承担者及风险承担职责,如下所述•任务提出者需要对整个项目范围、项目目标确定及项目全程掌控负责;•项目管理者需要对整个项目进度及项目实现负责;•软件开发者需要对项目实现负责;•测试人员需要对项目各功能环节,进行黑、白盒测试,对测试用例、结果负责;文档约定
1.3一般地讲,界面设计应包括以下几项屏幕环境设置以用户电脑屏幕大小为准,由程序控制自动调整适用用户屏幕1字型与字体使用统一字体,字体标准的选择依据操作系统类型决定中文采用标准字体,2“宋体”,英文采用标准不考虑特殊字体隶书、草书等,特殊情况可以使用Microsoft SansSerif图片取代,保证每个用户使用起来显示都很正常颜色界面颜色,以蓝色色调3提示提示警告、信息、错误,使用对应的表示方法,采用层的方式,以提示框的形式呈4现;图标有标准的图标风格设计,统一的构图布局,有统一的色调、对比度、色阶,以及图5片风格;底图应该融于底图,使用浅色,低对比,尽量少的使用颜色;列表框页面列表的条数为条,层的列表条数为条62010常用键常用快捷方式,按刷、按屏幕最大化7F5F12日期类型以时间为基准,时间在业务涉及多个国家和地区的时间,我国8UTC UTC位于东八时区,本地时间二时间小时UTC+8界面语言界面语言支持,依据用户需求而定目前,仅支持简体中文9其它10预期读者和阅读建议
1.4本说明书预期读者对象是用户、项目管理者、开发人员、测试人员等等参考资料
1.5本详细设计报告参考文献及资料,如下所述•本项目的合同书•本项目技术协议•系统规格需求说明•概要设计说明支撑环境
2.数据库管理系统
2.1采用主流数据库软件系统,包括、、、等Oracle DB2Sybase SQLServerMySQL开发工具、中间件以及数据库接口
2.2描述所选用的工具软件和中间件的名称、版本号,以及开发工具与数据库或者中间件接口的情况如果使用了多种开发工具、辅助开发工具、第三方软件部件、多种中间件、多种接口、等答应该逐项分别描述,并且说明每一项的适用范围需要描述的内容可能包括产品名称以及发行厂商•同中产品名称以及发行厂商
2.1版本号•同中版本号
2.1补丁包版本号•同中补丁包版本号
2.1语言或代码集•同中语言或代码集
2.1数据库接口名称•描述数据库接口的名称,如果使用别名时,应同时描述使用的别名数据库接口方式•描述与数据库接口的方式,并说明该接口方式的特点;如果需要,还应该说明使用时的注意事项•数据库接口设置描述各种接口设置,包括协议、端口号等等硬件环境
2.3需求名称详细要求用户端硬件环处理器以上CPU DualXeon43GHz境计算机配置内存以上2G硬盘以上200系统位操作系统64用户端硬件环通畅的网络境网络需求(简体中文版)及以上用户端软件环WindowsXP境浏览器及以上用户端软件环IE8境网络环境
2.4通畅的网络多种支撑环境开发要点
2.5当软件产品将来可能遇到的多种运行环境时,应该分别按照节至节的内容列表描述
3.
13.4如果软件产品各个子系统的运行环境不完全一样时,应该分子系统按照节至节的内容列
3.
13.4表描述遇到上述情况时,不仅需要详细描述各种软件开发、调试、测试的环境,为了确实保证软件产品将来能够在各种可能的运行环境中正常运行,还需要对软件产品进行严格的配置管理部件详细设计
3.这里所提及的软件部件,系指能够完成特定功能、相对独立的一些代码集合,它们可以是插件、组件、控件、函数、过程、子程序、动态连接库、等等具体呈何种形态,取决于实际采用的开发工具和将要实现的软件结构按照合适的顺序,逐个描述软件部件的详细情况描述的顺序可以是按层次横向进行描述,也可以是按模块纵向进行描述,总之描述的方式必须有利于读者理解软件结构每个部件采用一张软件部件表进行描述,软件部件表的格式见附表一,其中;•部件编号软件部件的统一顺序编号;对于实行配置管理的软件开发项目来说,该编号必须与该部件在配置管理中的编号相同•部件名称软件部件的正式英文名称,该名称是程序中使用的实际名称,必须符合国家相关软件命名标准•所属子系统指该部件所属的子系统;对于不分为多个子系统的软件来说,不必填写该栏•部件调用者指调用该部件的部件(或界面参数)的编号和名称•部件被调用者指被该部件所调用的部件的编号和名称•部件入口参数指该部件入口数据类名称或者数据名称,以及对这些数据的描述;如果部件没有入口参数,该栏为空•部件出口参数指该部件出口数据类名称或者数据名称,以及对这些数据的描述;如果部件没有出口参数,该栏为空•算法指该部件的算法形式表示,如果很简单、或者不存在,也可以为空•流程描述指该部件的处理流程的详细表示或描述•部件表示形式指该部件完成开发后的最终表示形式,具体形式取决于开发工具和软件结构,表示形式可能是■插件、组件、控件,■函数、过程、子程序,■存储过程,■动态连接库,■坐坐守守•运行环境描述该部件所适合的运行环境,即说明该部件是针对何种运行环境所开发的;可以直接描述运行环境,也可以描述运行环境的编号;对于实行配置管理的软件开发项目来说,该描述必须与该部件在配置管理中的描相同・性能要求指开发该部件时必须满足的专门要求,这些要求可以是■精度■灵活性■响应时间■可重用性结结■寸寸O提出的要求一般不宜超过项,以排列的先后顺序表示优先级3词汇表
4.列出本文件中用到的专业术语的定义,以及有关缩写的定义(如有可能,列出相关的外文原词)为了便于非软件专业或者非计算机专业人士也能够在一定的范围内,读懂软件系统详细设计报告,要求尽可能使用非软件专业或者非计算机专业的术语进行描述所以这里所指的专业术语,是指业务层面上的专业术语,而不是软件专业或者计算机专业的术语但是,对于无法回避的软件专业或者计算机专业术语,也应该列入词汇表,并且加以准确定义部件表格式
5.部件编号部件名称所属子系统部件调用者部件被调用者部件入口参数部件入口参数算法流程描述表示性能运行环境性能要求说明如果软件不见使用一张表表述不完时,可以采用续表描述,但是必须注明是那张表的续表界面表格式界面编号部件名称界面性质界面介质表示形式界面参数参数名内容说明说明如果软件不见使用一张表表述不完时,可以采用续表描述,但是必须注明是那张表的续表。