软件开发文档-程序员笑话 开发文档

共享知识分享快乐共享知识分享快乐卑微如蝼蚁、坚强似大象卑微如蝼蚁、坚强似大象在软件行业有一句话： 一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档， 软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。1、软件需求说明书：也称为软件规格说明。该说明书对所开发软件的功能、性能、用户 界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。软件需求说 明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一 个共同的理解、并使之面成为整个开发工作的基础。其格式要求如下：引言1 编写目的。2 背景3 定义 2 任务概述1 目标2 用户的特点3 假定和约束 3 需求规定1 对功能的规定2 对性能的规定精度时间特性的需求灵活性3 输入输出要求4 数据管理能力要求5 故障处理要求6 其他专门要求运行环境规定1 设备2 支持软件3 接口4 控制2、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。

编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。 流程、程序系统的组织 结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 总体设计1 需求规定2 运行环境3 基本设计概念和处理流程4 结构5 功能需求与程序的关系6 人工处理过程7 尚未解决的问题 3 接口设计1 用户接口2 外部接口 3.。3 内部接口运行设计1 运行模块的组合2 运行控制3 运行时间5 系统数据结构设计1 逻辑结构设计要点2 物理结构设计要求3 数据结构与程序的关系 6 系统出错处理设计1 出错信息2 补救措施3 系统维护设计。3.详细设计文档：主要是把我们每个小模块，小功能的业务逻辑处理用文字的方 式表达出来， 让程序员在编码的时候有一个依据和参照；同时，在进行详细文档设计的时候，有的软件公司也会根据不同的项目作出相应的《软件开发代码规范》性文档，以保障我们所做工作的统一性。如果一个软件系比较简单，层次很少， 本文件可以不单独编写，有关内容合并入概要设计说明书。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料程序设计系统的结构程序 1 设计说明1 程序描述2 功能3 性能4 输入项5 输出项6 算法7 流程逻辑8 接口9 存储分配0 注释设计1 限制条件2 测试计划3 尚未解决的问题 4 程序 2 设计说明 ...二、软件开发管理文档：可行性研究报告、项目开发计划、开发进度月报、项目开发总结、模块开发卷宗。

可行性研究报告：编写目的是，说明该软件开发项目的实现在技术、经济和社会条件方面的可行性： 评述为了合理达到开发目标而可能选择的各种方案；说明并论证所选定的方案。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料2 可行性研究的前提1 要求2 目标3 条件、假定和限制4 进行可行性研究的方法5 评价尺度3 对现有系统的分析1 处理流程和数据流程2 工作负荷3 费用开支4 人员5 设备6 局限性所建议的系统1 对所建议系统的说明2 处理流程和数据流程3 改进之处4 影响结设备的影响对软件的影响对用户单位机构的影响对系统运行过程的影响对开发的影响对地点和设备的影响对经费开支的影响局限性技术条件方面的可行性5 可选择的其他系统的可行性1 可选择的系统方案12 可选择的系统方案2 6 投资及效益分析1 支出基本建设投资其他一次性支出非一次性支出2 收益一次性收益非一次性收益不可定量的收益3 收益投资比4 投资回收周期5 敏感性分析社会因素方面的可行性1 法律方面的可行性2 使用方面的可行性 8 结论项目开发计划：是为软件项目实施方案制定出的具体计划。项目开发计划应提 前给管理部门，并作为开发阶段评审的基础。

编制项目开发计划的止的是用文件的形式软件开发文档，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、 所需的软硬条件等问题做出的安排记载下来，以便根据本计划开展和检查项目的开发工作。其格式要求如下：引言1 编写目的2 定义3 参考资料项目概述1 工作内容2 主要参加人员3 产品程序方件服务非移交的产品4 验收标准5 完成项目的最迟期限6 本计划的批准者和批准日期 3 实施计划1 工作任务的分配与人员分工2 接口人员3 进度4 预算5 关键问题 4 支持条件1 计算机系统支持2 需收用户承担的工作3 由外单位提供的条件 5 专题计划要点开发进度月报： 开发进度月报的编制目的是及时向有关部门汇报项目开发的进度和情况，以便及时发现和处理开发过程中出现的问题，一般开发进度月报是 以项目组单位每月编写的。 如果被开发的软件系统规模比较大，整个工程项目被划分给若干个分项目驵承担，开发进度月报将以分项目为单位搂月编写。其格式要求如下：标题工程进度与状态1 进度2 状态资源耗用与状态1 资源耗用工时3．1．3 机时2 状态经费支出与状态1 经费支出支持性费用设备购置费2 状态下一个月的工作计划建议项目开发总结：软件项目开发完成之后，应当与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。

此外，还需对开发工作做出评价， 总结经验和教训。 项目开发总结报告的编制是为了总结本项目开发工作的经验， 说明实际取得的开发结果以及对整个开发工作的各个方面的评价。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 实际开以结果1 产品2 主要功能和性能3 基本流程4 进度5 费用3 开发工作评价1 对生产效率的评价2 对产品质量的评价3 对技术方法的评价4 出错原因的分析 4 经验与教训模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一 个模块或一组密切相关的模块的复制进编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇意低层次开发的进度和结果，经便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。1 标题2 模块开发情况表：其中模块开发情况表的格式如下表：模块标识符模块标识符模块的描述性名称代码设计（计划开始日期 实际开始日期） 模块测试（计划开始日期 实际开始日期） 组装测试（计划开始日期 实际开始日期） 代码复查 (日期/签字)源代码行数（预计 /实际）目际模块大小（预计 实际） 项目负责人批准 ( 日期/签字)功能说明设计说明源代码清单测试说明复审的结论三、软件开发测试文档：概要测试计划、详细测试计划、测试实施计划、测试分析报告。

概要测试计划：是软件项目实施计划中的一项重要的内容，应当在软件开发初 期、即需求分析阶段制订。 项计划应当定义被测试对象和测试目标，确定测试阶段和测试周期的划分；制订测试人员、软硬件资源和测试进度等方面的计划， 规定软件测试方法，测试标准以及支持环境和测试工具。详细测试计划： 是针对子系统在特定的测试阶段所要进行的测试工作制订详细计划，它详细说明规定了测试小组的各项测试任务，测试策略、 任务分配和进度安排等。测试实施计划： 测试人员的测试实施计划是根据详细计划制订的测试者的测试具体实施计划。 它规定了测试者在每一轮测试中负责测试的内容，测试强度和工作进度等。测试实施计划是整个软件测试的组成部分，是检查测试实际执行情况的重要依据。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 计划1 软件说明2 测试内容3 测试进度安排条件测试资料测试培训4 测试3 测试设计说明1 测试控制输入输出过程2 测试 4 评价准则1 范围2 数据整理3 尺度测试分析报告：测试工作完成以后，应当提交测试计划情况说明书软件开发文档，对测试结果加以分析，并提出测试的结论性意见。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 测试概要测试结果及发现1 测试 12 测试 2对软件功能的结论1 功能 1能力限制2 功能2 5 分析摘要1 能力2 缺陷和限制3 建议4 评价6 测试资源消耗四、用户文档：用户手册、操作手册。

用户手册：用户手册的编制是要使用非专门术语的语言，充分地描述该软件系 统所具有的功能及基本的使用方法，使用户（或潜在用户） 通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 用途1 功能2 性能精度时间特性灵活性3 安全保密 3 运行环境1 硬设备2 支持软件3 数据结构 4 使用过程1 安装与初始化2 输入输入数据的现实背景输入格式输入举例3 输出输出数据的现实背景输出格式输出举例4 文卷查询5 出错处理和恢复6 终端操作操作手册： 操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节。其格式要求如下：引言1 编写目的2 背景3 定义4 参考资料 2 软件征述1 软件的结构2 程序表3 文卷表安装与初始化运行说明1 运行表2 运行步骤3 运行 1运行控制操作控制输入输出文卷输出文段输出文段的复制恢复过程4．4 运行 2 ...非常规过程远程操作维护建议：软件产品投入运行之后，可能有修改、更正等问题。应当对存在的问题、修改的考虑以及修改的影响估计等作详细的描述，写成维护修改建议、 提交审批。其格式要求如下：引言1 综述2 术语及缩写语3 参考资料 2 程序结构描述 3 维护过程1 启动2 系统的查询及事件报告功能3 硬件状态能功能描述 4 出错处理及非常规过程1 系统重启动过程2 严重故障时的紧急处理3 一