软件详细设计编写说明书.doc

XXX项目/软件/系统
详细设计说明书
文档过程记录表
时间
修正内容
校对人
版本号
备注
目录
第一章 引言 1
编写目的 1
背景 1
参考资料 1
术语定义及说明 1
第二章 设计概述 1
任务和目标 1
需求概述 1
运行环境概述 1
条件与限制 1
详细设计方法和工具 1
第三章 系统详细需求分析 1
详细需求分析 1
详细系统运行环境及限制条件分析接口需求分析 1
第四章 总体方案确认 1
系统总体结构确认 1
系统详细界面划分 1
应用系统与支撑系统的详细界面划分 1
系统内部详细界面划分 1
第五章 系统详细设计 1
系统结构设计及子系统划分 1
系统功能模块详细设计 1
系统界面详细设计 1
外部界面设计 1
内部界面设计 1
用户界面设计 1
第六章 数据库系统设计 1
1
信息模型设计 1
数据库设计 1
设计依据 1
数据库种类及特点 1
数据库逻辑结构 1
物理结构设计 1
数据库安全 1
数据字典 1
第七章 非功能性设计 1
第八章 环境配置 1
引言
编写目的
说明编写详细设计方案的主要目的。
说明书编制的目的是说明一个软件系统各个层次中的每个程序(每个模块或子程序)和数据库系统的设计考虑,为程序员编码提供依据。
如果一个软件系统比较简单,层次很少,本文件可以不单独编写,和概要设计说明书中不重复部分合并编写。
方案重点是模块的执行流程和数据库系统详细设计的描述。
背景
应包含以下几个方面的内容:
A. 待开发软件系统名称;
B. 该系统基本概念, 如该系统的类型、从属地位等;
C. 开发项目组名称。
参考资料
列出详细设计报告引用的文献或资料,资料的作者、标题、出版单位和出版日期等信息,必要时说明如何得到这些资料。
术语定义及说明
列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。
设计概述
任务和目标
说明详细设计的任务及详细设计所要达到的目标。
需求概述
对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等,尤其需要描述系统性能需求。
运行环境概述
对本系统所依赖于运行的硬件,包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述,及配置要求。
条件与限制
详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。
详细设计方法和工具
简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF(I2DEF)方法、E-R图,数据流程图、业务流程图、选用的CASE工具等,尽量采用标准规范和辅助工具。
系统详细需求分析
主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认,并对由于情况变化而带来的需求变化进行较为详细的分析。
详细需求分析
包括:
详细功能需求分析
详细性能需求分析
详细资源需求分析
详细系统运行环境及限制条件分析
详细系统运行环境及限制条件分析接口需求分析
包括:
系统接口需求分析
现有硬、软件资源接口需求分析
引进硬、软件资源接口需求分析
总体方案确认
着重解决系统总体结构确认及界面划分问题。
系统总体结构确认
对系统组成、逻辑结构及层次进行确认,对应用系统、支撑系统及各自实现的功能进行确认,细化集成设计及系统工作流程,特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括:
系统组成、逻辑结构及层次确认
应用系统结构确认
支撑系统结构确认
系统集成确认
系统工作流程确认
系统详细界面划分
应用系统与支撑系统的详细界面划分
应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式,网络及数据库对应用系统的支撑方式,全局数据的管理与存取方式等。
系统内部详细界面划分
系统各功能之间的界面包括覆盖范围,模块间功能调用涉及到的系统模块及方法,全局数据格式,系统性能要求等。