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

在软件行业有一句话： 一个软件能否顺利的完成并且功能是否完善， 重要是看这个软件有多少文档， 软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能 会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档： 软件开发文档包括软件需求说明书、 数据要求说有书、 概要设计说明书、 详细设计说明书。 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 输入输出要求 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 数据结构与程序的关系 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 流 程逻辑 3 ．8 接口 3 ．9 存储分配 3 ．10 注释设计 3．11 限制条件 3. 。12 测试计划 3 ．13 尚未解决的问题 4 程序 2 （标识符）设计说明 ... 二、软件开发管理文档：可行性研究报告、项目开发计划、开发进度月报、项目开发总结、模块开发卷宗。 1.可行性研究报告： 编写目的是，说明该软件开发项目的实现在技术、经济和社会条件方面的可行性：评述为了合 理达到开发目标而可能选择的各种方案；说明并论证所选定的方案。 其格式要求如下： 1 引言 1．1 编写目的 1．2 背景 1．3 定义 1．4 参考资料 2 可行性研究的前提 2 ．1 要求 2 ．2 目标 2．3 条件、假定和限制 2 ．4 进行可行性研究的方法 2 ．5 评价尺度 1 3 对现有系统的分析 3 ．1 处理流程和数据流程 3 ．2 工作