软件开发文档说明(又全又详细).pdfVIP

软件开发文档说明(又全又详细)--第1页

软件开发文档说明(又全又详细)

在软件行业有一句话：一个软件能否顺利的完成并且功能

是否完善，重要是看这个软件有多少文档，软件开发文档是一

个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出

来的软件也不可能会好；开发文档的好坏可以直接影响到所开

发出来软件的成功与否。

一、软件开发设计文档：软件开发文档包括软件需求说明

书、数据要求说有书、概要设计说明书、详细设计说明书。1.

软件需求说明书：也称为软件规格说明。该说明书对所开发软

件的功能、性能、用户界面及运行环境等做出详细的说明。它

是用户与开发人员双方对软件需求取得共同理解基础上达成的

协议，也是实施开发工作的基础。软件需求说明书的编制目的

的就是为了使用户和软件开发者双方对该软件的初始规定有一

个共同的理解、并使之面成为整个开发工作的基础。

其格式要求如下：

1引言1．1编写目的。1．2背景1．3定义

2任务概述2．1目标2．2用户的特点2．3假定和约束

3需求规定3．1对功能的规定3．2对性能的规定

3．2．1精度3．2．2时间特性的需求3．2．3灵活性3．3

软件开发文档说明(又全又详细)--第1页

软件开发文档说明(又全又详细)--第2页

输入输出要求3．4数据管理能力要求3．5故障处理要求

3．6其他专门要求

4运行环境规定4．1设备4．2支持软件4．3接口4．4

控制

2.概要设计说明书：又称系统设计说明书，这里所说的系

统是指程序系统。编制的目的是说明对程序系统的设计斟酌，

包括程序系统的基本处理。流程、程序系统的组织结构、模块

划分、功能分配、接口设计。运河行设计、数据结构设计和出

错处理设计等，为程序的详细设计提供基础。

其花式请求以下：

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数据结构与程序的关系

软件开发文档说明(又全又详细)--第2页

软件开发文档说明(又全又详细)--第3页

6系统出错处理设计6．1出错信息6．2补救措施6．3

系统维护设计。

3.详细设计文档：主要是把我们每个小模块，小功能的业

务逻辑处理用文字的方式表达出来，让程序员在编码的时候有

一个依据和参照；同时，在进行详细文档设计的时候，有的软

件公司也会根据不同的项目作出相应的《软件开发代码规范》

性文档，以保障我们所做工作的统一性。如果一个软件系比较

简单，层次很少，本文件可以不单独编写，有关内容合并入概

要设计说明书。

其花式请求以下：

1弁言1．1编写目的1．2配景1．3定义1．4参考资料

2程序设计系统的结构

3程序1（标识符）设计说明3．1程序描述3．2功能

3．3性能3．4输入项3．5输进项3．6算法3．7流程逻辑