篇一：软件开发设计文档模板
软件开发设计文档
文档管理信息表
文档变更纪录
文档主要评审意见
QA
组
目 录
1 开发规划 .......................................................................................................................................... 1
1.1
1.2
1.3
1.4
2 开发人员 ................................................................................................................................. 1 开发计划 ................................................................................................................................. 2 开发环境和工具 ..................................................................................................................... 3 开发规范 ................................................................................................................................. 3 总体设计 .......................................................................................................................................... 4
2.1 概念术语描述 ......................................................................................................................... 4
2.1.1 术语1 .............................................................................................................................. 4
2.1.2 术语2 .............................................................................................................................. 4
2.2 基本设计描述 ......................................................................................................................... 5
2.2.1 系统总体逻辑结构图 ..................................................................................................... 5
2.2.2 系统部署结构图 ............................................................................................................. 6
2.3 主要界面流程描述 ................................................................................................................. 7
2.3.1 功能1界面流程 ............................................................................................................. 7
2.3.2 功能2界面流程 ............................................................................................................. 7
2.4 模块列表 ................................................................................................................................. 8 3
4 数据结构 .......................................................................................................................................... 9 接口规范 ........................................................................................................................................ 10
4.1 <模块1 API> ......................................................................................................................... 10
4.1.1 Interface1 ...................................................................................................................... 10
4.1.2 Interface2 ...................................................................................................................... 10
4.2 <模块2 API> ......................................................................................................................... 11
4.3 <模块3 API> ......................................................................................................................... 11
4.4 <数据库API> ....................................................................................................................... 11
5 模块设计 ........................................................................................................................................ 12
5.1 MODULE1设计 ...................................................................................................................... 12
5.1.1 模块设计描述 ............................................................................................................... 12
5.1.2 模块界面描述 ............................................................................................................... 12
5.2 MODULE2设计 ...................................................................................................................... 13
6 附录................................................................................................................................................ 14
6.1
6.2
6.3 第三方组件 ........................................................................................................................... 14 参考资料 ............................................................................................................................... 15 附加文档 ............................................................................................................................... 15
篇二：软件开发文档模版
目录
1. 范围 ............................................................................................................................................. 1
2. 总体要求 ..................................................................................................................................... 1
2.1 总体功能要求 ....................................................................................................................... 1
2.2 软件开发平台要求 ............................................................................................................... 1
2.3 软件项目的开发实施过程管理要求 .................................................................................... 2
2.3.1 软件项目实施过程总体要求 ........................................................................................ 2
2.3.2 软件项目实施变更要求 ................................................................................................ 2
2.3.3 软件项目实施里程碑控制 ............................................................................................ 2
3. 软件开发 ..................................................................................................................................... 3
3.1 软件的需求分析 ................................................................................................................... 3
3.1.1 需求分析 ........................................................................................................................ 3
3.1.2 需求分析报告的编制者 ................................................................................................ 4
3.1.3 需求报告评审 ................................................................................................................ 4
3.1.4 需求报告格式 ................................................................................................................ 4
3.2 软件的概要设计 ................................................................................................................... 4
3.2.1 概要设计 ........................................................................................................................ 4
3.2.2 编写概要设计的要求 .................................................................................................... 4
3.2.3 概要设计报告的编写者 ................................................................................................ 4
3.2.4 概要设计和需求分析、详细设计之间的关系和区别 ................................................ 4
3.2.5 概要设计的评审 ............................................................................................................ 4
3.2.6 概要设计格式 ................................................................................................................ 4
3.3 软件的详细设计 ................................................................................................................... 5
3.3.1 详细设计 ........................................................................................................................ 5
3.3.2 特例 ................................................................................................................................ 5
3.3.3 详细设计的要求 ............................................................................................................ 5
3.3.4 数据库设计 .................................................................................................................... 5
3.3.5 详细设计的评审 ............................................................................................................ 5
3.3.6 详细设计格式 ................................................................................................................ 5
3.4 软件的编码 ........................................................................................................................... 5
3.4.1 软件编码 ........................................................................................................................ 5
3.4.2 软件编码的要求 ............................................................................................................ 5
3.4.3 编码的评审 .................................................................................................................... 6
3.4.4 编程规范及要求 ............................................................................................................ 6
3.5 软件的测试 ........................................................................................................................... 6
3.5.1 软件测试 ........................................................................................................................ 6
3.5.2 测试计划 ........................................................................................................................ 6
3.6 软件的交付准备 ................................................................................................................... 6
3.6.1 交付清单 ........................................................................................................................ 6
3.7 软件的鉴定验收 ................................................................................................................... 7
3.7.1 软件的鉴定验收 ............................................................................................................ 7
3.7.2 验收人员 ........................................................................................................................ 7
3.7.3 验收具体内容 ................................................................................................................ 7
3.7.4 软件验收测试大纲 ........................................................................................................ 7
3.8 培训 ....................................................................................................................................... 7
3.8.1 系统应用培训 ................................................................................................................ 7
3.8.2 系统管理的培训（可选） ............................................................................................ 8
附录A 软件需求分析报告文档模板 .......................................................................................... 9
附录B 软件概要设计报告文档模板 ........................................................................................ 21
附录C 软件详细设计报告文档模板 ........................................................................................ 33
附录D 软件数据库设计报告文档模板 .................................................................................... 43 附录E 软件测试(验收)大纲 ................................................................... 错误！未定义书签。5
1. 范围
本指南用于指导软件开发者为南京市交通局开发软件项目的过程，通过规范软件项目承担单位的开发过程达到提高软件质量，降低维护成本的目的。开发者应根据本指南进行软件开发和编制软件开发文档。本指南是对软件项目承担单位的基本要求。在本指南的附录A至E中提供了文档的编写模板供开发者参考，在进行具体软件开发时，开发者可根据实际情况采编写，但必须提供双方约定的文档，文档中约定的内容必须描述清楚。
2. 总体要求
2.1 总体功能要求
网络应用环境以Internet/Intranet技术为核心。
开发者应在充分分析需求的基础上，选择采用B/S结构或者C/S结构。
软件系统的数据库应依照《南京市交通局信息化数据库建设规范》进行设计和建设。 本指南中没有规定开发者采用何种具体的软件工程开发方法，开发者可根据项目具体特
点、自身擅长来选择采用面向过程的方法、面向对象的方法或面向数据的方法，但建议开发 商使用面向对象软件工程的方法，如：采用目前被广泛使用的RUP(Rational Unified Process)方法来进行分析、设计和开发。
2.2 软件开发平台要求
开发者开发的软件必须能够在南京市交通局规定的软件平台上正常运行。目前软件平台为：
数据库管理系统：
Oracle 9i以上版本
中间件(应用服务器)系统：
IBM WebSphere
OA系统：
Lotus Domino/Notes
网络架构：
完全支持TCP/IP协议
开发工具或技术体系：
为保证软件的上下兼容性，开发者应选择比较通用的开发工具的较新版本进行开
发，如Microsoft Visual Studio.Net，Borland Delphi，C++ Builder, 或J2EE(Java2 P1atform Enterprise Edition)等。
2.3 软件项目的开发实施过程管理要求
2.3.1 软件项目实施过程总体要求
（一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提出整改意见。
（二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，开发者需分阶段提交相关文档。
（三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织验收组对软件进行验收审查。
2.3.2 软件项目实施变更要求
在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须经过交通局书面同 意方可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变更记录， 以使变更处于可控制的状态。变更单如下表所示：
表 2-1 变更单
2.3.3 软件项目实施里程碑控制
交通局将分四个阶段进行把关，召开专家审查会。
（一） 需求分析（结合原型进行审查）确认；
（二） 概要设计+数据库设计；
（三） 预验收（试运行后）；
（四） 正式验收（推广使用后）。
3. 软件开发
合同签订以后，项目承担单位即可组织项目组进行软件开发工作。软件开发必须严格按照软件工程的要求进行。开发过程包括开发者的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。
3.1 软件的需求分析
3.1.1 需求分析
首先，开发者和交通局应共同对交通局的应用需求作充分的调研，提交完整的需求分析 报告。在需求分析报告中必须描述的基本问题是：功能、性能、强加于实现的设计限制、属 性、外部接口。应当避免把设计或项目需求写入需求分析报告中。它必须说明由软件获得的 结果，而不是获得这些结果的手段。
软件需求可以用若干种方法来表达，如通过输入、输出说明；使用代表性的例子；用规范化的模型。开发者应尽可能地使用模型的方式，因为这是表达复杂需求的精确和有效的方法。比如用统一建模语言（UML）来描述需求。
编写需求分析报告的要求
a．无歧义性
对最终产品的每一个特性用某一术语描述；若某一术语在某一特殊的行文中使用时具有多种含义，那么应对该术语的每种含义做出解释并指出其适用场合。
b．完整性
需求分析报告应该包括全部有意义的需求，无论是关系到功能的、性能的、设计约束的、还是关系到外部接口方面的需求；对所有可能出现的输入数据的响应予以定义，要对合法和非合法的输入值的响应做出规定；填写全部插图、表、图示标记等；定义全部术语和度量单位。
c．可验证性
需求分析报告描述的每一个需求应是可以验证的。可以通过一个有限处理过程来检查软件产品是否满足需求。
d．一致性
在需求分析报告中的各个需求的描述不能互相矛盾。
e．可修改性
需求分析报告应具有一个有条不紊、易于使用的内容组织；没有冗余，即同一需求不能在需求分析报告中出现多次。
f．可追踪性
每一个需求的源流必须清晰，在进一步产生和改变文件编制时，可以方便地引证每一个需求。
g．运行和维护阶段的可使用性
需求分析报告必须满足运行和维护阶段的需要。在需求分析报告要写明功能的来源和目的。
篇三：软件开发文档模板
软件开发文档模板
1引言
1.1编写目的
1.2背景
1.3定义
1.4参考资料
2总体设计
2.1需求规定
2.2运行环境
2.3基本设计概念和处理流程
2.4结构
2.5功能器求与程序的关系
2.6人工处理过程
2.7尚未问决的问题
3接口设计
3.1用户接口
3.2外部接口
3.3内部接口
4运行设计
4.1运行模块组合
4.2运行控制 4.3运行时间 5系统数据结构设计 5.1逻辑结构设计要点
5.2物理结构设计要点
5.3数据结构与程序的关系
6系统出错处理设计
6.1出错信息
6.2补救措施
6.3系统维护设计
****************************************
2、http:///bzgf/bzgf.htmISO9001标准文档模版
第1章 引言
1.1 编写目的
1.2 术语
1.3 参考文献
第2章 系统概述
2.1 系统说明
2.2 系统任务
2.2.1 系统目标
2.2.2 运行环境
2.2.3 与其它系统关系 2.3 需求规定 2.3.1 功能需求 2.3.2 性能需求
2.3.3 数据要求
2.3.4 其它
第3章 总体设计
3.1 系统物理结构
3.1.1 系统流程图
3.1.2 设备清单
3.2 软件结构图
3.2.1 模块结构图
3.2.2 模块清单
第4章 模块功能描述
4.1 模块1（标识符） 功能
4.2 模块2 （标识符）功能
第5章 接口设计
5.1 用户界面
5.2 硬件接口
5.3 软件接口
5.4 通信接口 第6章 数据结构设计 6.1 数据结构1 （标识符） 6.1.1 结构属性
6.1.2 逻辑结构
6.1.3 物理结构
6.1.4 数据元素
6.2 数据结构2 （标识符）
第7章 运行设计
7.1 运行1
7.1.1 运行模块组合运行名称
7.1.2 运行控制操作
7.1.3 运行时间
7.2 运行2
第8章 系统安全
8.1 系统安全
8.2 数据安全
8.3 后备与恢复
8.4 出错处理
8.5 计算机病毒的防治措施
第9章 功能需求、数据结构和模块
9.1 功能需求与模块关系
9.2 数据结构与模块关系
****************************************
http:///yyal/yyal9.htm
概要设计说明书
1 引言
1.1 写目的：阐明编写概要设计说明书的目的，指明读者对象。
1.2 项目背景：应包括
● 项目的委托单位、开发单位和主管部门
● 该软件系统与其他系统的关系。
1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。
1.4 参考资料：
● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 ●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册
● 文档所引用的资料、采用的标准或规范。
2 任务概述
2.1 目标
2.2 需求概述
2.3 条件与限制
3 总体设计
3.2 总体结构和模块外部设计
3.3 功能分配：表明各项功能与程序结构的关系。
4 接口设计
4.1 外部接口：包括用户界面、软件接口与硬件接口。
4.2 内部接口：模块之间的接口。
5 数据结构设计
6 逻辑结构设计
所有文档的统一封面格式如下页所示。
7 物理结构设计
8 数据结构与程序的关系
9 运行设计
9.1 运行模块的组合
9.2 运行控制
9.3 运行时间
10 出错处理设计
10.1 出错输出信息
10.2 出错处理对策：如设置后备、性能降级、恢复及再启动等。
11 安全保密设计
12 维护设计
说明为方便维护工作的设施，如维护模块等。
****************************************
自己以前还保留了一份，四份，不尽相同
“概要设计说明书”编写规范
软件的概要设计又称为软件系统（程序系统）的设计，本文件应说明软件系统即程序系统设计的总体考虑，包括系统的基本处理流程、软件系统的组织结构、模块划分、功能分配、数据结构、接口、运行、 出错处理和系统维护等方面的设计，为详细设计提供基础。
１ 引言
1.1编写目的
说明编写本设计说明书的目的，指出预期的读者。
1.2背景
a. 说明待开发软件系统的名称。
b. 列出开发此软件系统的提出者、开发者、和用户。
1.3基线
说明本系统设计的设计基线。
1.4范围
说明本设计说明书所涉及的设计内容范围。
1.5定义
列出本设计说明书中用到的专门术语和外文字母组词的原词组。
1.6参考资料
a. 属于项目的其他已发表的文件；
b. 本设计说明书中引用到的文件、资料，包括所用到的软件开发标准。列出这些文件资料的标题、编号、发表日期、出版单位和查找来源。
2总体设计
2.1概述
2.1.1需求规定
说明本系统主要的输入、处理、输出的功能和性能要求等。
2.2.2运行环境
说明本系统运行的硬件环境和支持环境。
2.2设计
2.2.1设计构思
说明对本系统设计的构思、采用的关键技术、主要算法和关键数据结构。
2.2.2系统流程
a. 用流程图示出本系统的主要控制流程和处理流程；
b. 用流程图示出本系统主要的数据通路，并说明处理的主要阶段。
2.2.3结构设计
a. 系统元素
确定本系统的元素及其功能，用一览表说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，按层次给出它们的标识符和功能。
b. 系统层次结构
用框图分层次地给出各个系统元素之间的控制和被控制的关系。
2.2.4功能需求与程序的关系
用功能需求与程序的矩阵图表形式 ，示出各项功能的实现与各系统元素之间的分配关系。
3系统数据结构设计
3.1数据结构
列出本系统所使用的主要数据结构，包括名称、标识符及数据项等。
3.2数据结构与系统元素之间的关系
用数据结构与系统元素之间的矩阵图表形式，示出各个数据结构与访问这些数据结构的系统元素之间的关系。
4 接口设计
4.1用户接口
说明本系统向用户提供的命令、语法结构及系统回答信息等。
4.2外部接口
说明本系统的软件同硬件和支持软件之间的接口。
4.3内部接口
说明本系统内部相关模块之间的接口。
5运行设计
5.1系统初始化
说明本系统初始化过程。
5.2运行模块组合
说明本系统每项外界运行需经过哪些内部模块的组合和支持软件。
5.3运行控制
说明每项外界运行的控制方式、方法和操作步骤。
5.4运行时间
说明每项运行模块组合预计占用各种资源的时间。
5.5运行安全
说明系统安全运行的控制。
6信息结构设计（当有相关需求或软件规格定义有要求时）
按逻辑结构和物理结构给出本软件有关信息的设计要点。
6.1逻辑结构设计
6.1.1图形设计
6.1.2中文（包括单个汉字、短语、词组。）设计
6.2物理结构设计
6.2.1图形设计
6.2.2中文（包括单个汉字、短语、词组。）设计
6.3信息结构与程序的关系
用信息结构与系统元素之间的矩阵图表形式，示出各个信息结构与访问这些信息结构的系统元素之间的关系。
7 出错处理和维护
7.1出错信息
用一览表列出本系统各种可能出错或故障的信息形式及其含义。
7.2补救措施
说明系统故障出现后可能采取的变通措施，包括：
a. 后备技术——当系统原始数据一旦丢失时，启用副本的建立和启动技术； b. 降效技术——使用另一效率稍低的方法以求得所需结果的某些部份，如手工操作和人工记录数据；
c. 恢复及再启动技术——让系统从故障点恢复执行或系统从新启动运行的方法等。
免费论文网友情提示：本网站所有内容为共享上传提供，不涉及任何商业利益，本站对此不承担任何保证责任！
Copyright © www.csmayi.cn Corporation, All Rights Reserved 共享时代 共享你我他 版权所有