软件开发文档说明完整作业流程.docx

在软件行业有一句话：一个软件能否顺利完成而且功效是否完善，关键是看这个软件有多少文档，软件开发文档是一个软件支柱，假如你开发文档漏洞百出，那么你所开发出来软件也不可能会好；开发文档好坏能够直接影响到所开发出来软件成功是否。  

一、软件开发设计文档：软件开发文档包含软件需求说明书、数据要求说有书、概要设计说明书、具体设计说明书。

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 评价尺度
3 对现有系统分析 
3．1 处理步骤和数据步骤 
3．2 工作负荷 
3．3 费用开支 
3．4 人员 
3．5 设备
3．6 不足  
4 所提议系统 
4．1 对所提议系统说明 
4．2 处理步骤和数据步骤 
4．3 改善之处 
4．4 影响 
4．4．1 结设备影响 
4．4．2 对软件影响 
4．4．3 对用户单位机构影响 
4．4．4 对系统运行过程影响 
4．4．5 对开发影响
4．4．6 对地点和设备影响 
4．4．7 对经费开支影响 
4．5 不足 
4．6 技术条件方面可行性  
5 可选择其它系统可行性 
5．1 可选择系统方案1 
5．2 可选择系统方案2 
6 投资及效益分析 
6．1 支出 
6．1．1 基础建设投资 
6．1．2 其它一次性支出 
6．1．3 非一次性支出 
6．2 收益 
6．2．1 一次性收益 
6．2．2 非一次性收益 
6．2．3 不可定量收益 
6．3 收益投资比 
6．4 投资回收周期 
6．5 敏感性分析  
7 社会原因方面可行性 
7．1 法律方面可行性 
7．2 使用方面可行性  
8 结论  

2.项目开发计划：是为软件项目实施方案制订出具体计划。项目开发计划应提前给管理部门，并作为开发阶段评审基础。编制项目开发计划止是用文件形式，把对于在开发过程中各项工作责任人员、开发进度、所需经费预算、所需软硬条件等问题做出安排记载下来，方便依据本计划开展和检验项目标开发工作。
其格式要求以下：  
1 引言 
1．1 编写目标 
1．2 定义 
1．3 参考资料  
2 项目概述 
2．1 工作内容 
2．2 关键参与人员 
2．3 产品 
2．3．1 程序 
2．3．2 方件 
2．3．3 服务 
2．3．4 非移交产品 
2．4 验收标准 
2．5 完成项目标最迟期限 
2．6 本计划同意者和同意日期  
3 实施计划 
3．1 工作任务分配和人员分工 
3．2 接口人员 
3．3 进度 
3．4 预算 
3．5 关键问题  
4 支持条件 
4．1 计算机系统支持 
4．2 需收用户负担工作 
4．3 由外单位提供条件  
5 专题计划关键点  

3.开发进度月报：开发进度月报编制目标是立即向相关部门汇报项目开发进度和情况，方便立即 发觉和处理开发过程中出现问题，通常开发进度月报是以项目组单位每个月编写。假如被开发软件系统规模比较大，整个工程项目被划分给若干个分项目驵负担，开发进度月报将以分项目为单位搂月编写。 其格式要求以下： 
1 标题  
2 工程进度和状态 
2．1 进度 
2．2 状态  
3 资源耗用和状态 
3．1 资源耗用 
3．1．1 工时 
3．1．3 机时 
3．2 状态  
4 经费支出和状态 
4．1 经费支出 
4．1．1 支持性费用 
4．1．2 设备购置费 
4．2 状态  
5 下30天工作计划  
6 提议  

4.项目开发总结：软件项目开发完成以后，应该和项目实施计划对照，总坚固际实施情况，如进度、 结果、资源利用、成本和投入人力。另外，还需对开发工作做出评价，总结经验和教训。项目开发总结汇报编制是为了总结本项目开发工作经验，说明实际取得开发结果和对整个开发工作各个方面评价。
其格式要求以下：  
1 引言 
1．1 编写目标 
1．2 背景 
1．3 定义 
1．4 参考资料  
2 实际开以结果 
2．1 产品 
2．2 关键功效和性能 
2．3 基础步骤 
2．4 进度 
2．5 费用  
3 开发工作评价 
3．1 对生产效率评价 
3．2 对产品质量评价 
3．3 对技术方法评价 
3．4 犯错原因分析  
4 经验和教训  

5.模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来，每完成一个模块或一组亲密相关模块复制进编写一份，应该把全部模块开发卷宗聚集在一起。编写目标是统计和汇意低层次开发进度和结果，经便于对整个模块开发工作管理和复审，并为未来维护提供很有用技术信息。 1 标题 
2 模块开发情况表：
其中模块开发情况表格式以下表：
模块标识符

模块描述性名称

代码设计（计划开始日期 实际开始日期）

模块测试（计划开始日期 实际开始日期）

组装测试（计划开始日期 实际开始日期）

代码复查(日期/签字)

源代码行数（估计/实际）

目际模块大小（估计 实际）

项目责任人同意(日期/签字)

3 功效说明  
4 设计说明  
5 源代码清单  
6 测试说明  
7 复审结论    

三、软件开发测试文档：概要测试计划、具体测试计划、测试实施计划、测试分析汇报。

1.概要测试计划：是软件项目实施计划中一项关键内容，应该在软件开发早期、即需求分析阶段制订。项计划应该定义被测试对象和测试目标，确定测试阶段和测试周期划分；制订测 试人员、软硬件资源和测试进度等方面计划，要求软件测试方法，测试标准和支持环境和测试工具。

2.具体测试计划：是针对子系统在特定测试阶段所要进行测试工作制订具体计划，它具体说明要求了测试小组各项测试任务，测试策略、任务分配和进度安排等。

3.测试实施计划：测试人员测试实施计划是依据具体计划制订测试者测试具体实施计划。它要求了测试者在每一轮测试中负责测试内容，测试强度和工作进度等。测试实施计划是整个软件测试组成部分，是检验测试实际实施情况关键依据。
其格式要求以下： 
1 引言  
1．1 编写目标 
1．2 背景 
1．3 定义 
1．4 参考资料  
2 计划  
2．1 软件说明 
2．2 测试内容 
2．3 测试
2．3．1 进度安排 
2．3．2 条件 
2．3．3 测试资料 
2．3．4 测试培训 
2．4 测试 
3 测试设计说明  
3．1 测试 
3．1．1 控制 
3．1．2 输入 
3．1．3 输出 
3．1．4 过程 
3．2 测试  
4 评价准则  
4．1 范围 
4．2 数据整理 
4．3 尺度  

4.测试分析汇报：测试工作完成以后，应该提交测试计划情况说明书，对测试结果加以分析，并提 出测试结论性意见。
其格式要求以下： 
1 引言 
1．1 编写目标 
1．2 背景 
1．3 定义 
1．4 参考资料  
2 测试概要  
3 测试结果及发觉  
3．1 测试 1
3．2 测试 2  
4 对软件功效结论  
4．1 功效 1 
4．1．1 能力 
4．1．2 限制
4．2 功效 2
5 分析摘要  
5．1 能力 
5．2 缺点和限制 
5．3 提议 
5．4 评价  
6 测试资源消耗

四、用户文档：用户手册、操作手册。

1.用户手册：用户手册编制是要使用非专门术语语言，充足地描述该软件系统所含有功效及基础使用方法，使用户（或潜在用户）经过本手册能够了解该软件用途，而且能够确定在什么情况下，怎样使用它。
其格式要求以下： 

1 引言  
1．1 编写目标 
1．2 背景 
1．3 定义 
1．4 参考资料  
2 用途  
2．1 功效 
2．2 性能 
2．2．1 精度 
2．2．2 时间特征 
2．2．3 灵活性 
2．3 安全保密  
3 运行环境  
3．1 硬设备 
3．2 支持软件 
3．3 数据结构  
4 使用过程  
4．1 安装和初始化 
4．2 输入 
4．2．1 输入数据现实背景 
4．2．2 输入格式 
4．2．3 输入举例 
4．3 输出 
4．3．1 输出数据现实背景 
4．3．2 输出格式 
4．3．3 输出举例 
4．4 文卷查询 
4．5 犯错处理和恢复 
4．6 终端操作  

2.操作手册：操作手册编制是为了向操作人员提供该软件每一个运行具体过程和相关知识，包含操作方法细节。
其格式要求以下：

1 引言  
1．1 编写目标 
1．2 背景 
1．3 定义 
1．4 参考资料  
2 软件征述  
2．1 软件结构 
2．2 程序表 
2．3 文卷表  
3 安装和初始化  
4 运行说明  
4．1 运行表 
4．2 运行步骤 
4．3 运行 1
4．3．1 运行控制 
4．3．2 操作控制 
4．3．3 输入输出文卷 
4．3．4 输出文段 
4．3．5 输出文段复制
4．3．6 恢复过程 
4．4 运行 2 ...
5 很规过程  
6 远程操作  

3.维护提议：软件产品投入运行以后，可能有修改、更正等问题。应该对存在问题、修改考虑和修改影响估量等作具体描述，写成维护修改提议、提交审批。
其格式要求以下： 
1 引言  
1．1 综述 
1．2 术语及缩写语 
1．3 参考资料  
2 程序结构描述  
3 维护过程  
3．1 开启 
3．2 系统查询及事件汇报功效 
3．3 硬件状态能功效描述  
4 犯错处理及很规过程  
4．1 系统重开启过程 
4．2 严重故障时紧急处理 
4．3 通常故障处理 
4．4 数据备份工作  
5 附录  
5．1 附录一 
5．2 附录二  

文档编制说明：文档标题用于说明项目标名称，文档专题用于说明本文档内容，文档编号和文档版本关键用于归档和检索。