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

在软件行业有一句话：一个软件能否顺利完成而且功效是否完善，关键是看这个软件有多少文档，软件开发文档是一个软件支柱，假如你开发文档漏洞百出，那么你所开发出来软件也不可能会好；开发文档好坏能够直接影响到所开发出来软件成功是否。 一、软件开发设计文档：软件开发文档包含软件需求说明书、数据要求说有书、概要设计说明书、具体设计说明书。 1、软件需求说明书：也称为软件规格说明。 该说明书对所开发软件功效、性能、用户界面及运行环境等做出具体说明。它是用户和开发人员双方对软件需求取得共同理解基础上达成协议，也是实施开发工作基础。软件需求说明书编制目标就是为了使用户和软件开发者双方对该软件初始要求有一个共同了解、并使之面成为整个开发工作基础。其格式要求以下：1引言11编写目标。 12背景13定义2任务概述21目标22用户特点23假定和约束3需求要求31对功效要求32对性能要求321精度322时间特征需求323灵活性33输入输出要求34数据管理能力要求35故障处理要求36其它专门要求4运行环境要求41设备42支持软件43接口44控制2、概要设计说明书：又称系统设计说明书，这里所说系统是指程序系统。编制目标是说明对程序系统设计考虑，包含程序系统基础处理。步骤、程序系统组织结构、模块划分、功效分配、接口设计。运河行设计、数据结构设计和犯错处理设计等，为程序具体设计提供基础。其格式要求以下：1引言11编写目标12背景13定义14参考资料2总体设计21需求要求22运行环境23基础设计概念和处理步骤24结构25功效需求和程序关系26人工处理过程27还未处理问题3接口设计31用户接口32外部接口3.。3内部接口4运行设计41运行模块组合42运行控制43运行时间5系统数据结构设计51逻辑结构设计关键点52物理结构设计要求53数据结构和程序关系6系统犯错处理设计61犯错信息62补救方法63系统维护设计。 3.具体设计文档：关键是把我们每个小模块，小功效业务逻辑处理用文字方法表示出来，让程序员在编码时候有一个依据和参考；同时，在进行具体文档设计时候，有软件企业也会依据不一样项目作出对应软件开发代码规范性文档，以保障我们所做工作统一性。假如一个软件系比较简单，层次极少，本文件能够不单独编写，相关内容合并入概要设计说明书。 其格式要求以下：1引言11编写目标12背景13定义14参考资料2程序设计系统结构3程序1设计说明31程序描述32功效33性能34输入项35输出项36算法37步骤逻辑38接口39存放分配310注释设计311限制条件312测试计划313还未处理问题4程序2设计说明.二、软件开发管理文档：可行性研究汇报、项目开发计划、开发进度月报、项目开发总结、模块开发卷宗。 1.可行性研究汇报：编写目标是，说明该软件开发项目标实现在技术、经济和社会条件方面可行性：评述为了合理达成开发目标而可能选择多种方案；说明并论证所选定方案。 其格式要求以下：1引言11编写目标12背景13定义14参考资料2可行性研究前提21要求22目标23条件、假定和限制24进行可行性研究方法25评价尺度3对现有系统分析31处理步骤和数据步骤32工作负荷33费用开支34人员35设备36不足4所提议系统41对所提议系统说明42处理步骤和数据步骤43改善之处44影响441结设备影响442对软件影响443对用户单位机构影响444对系统运行过程影响445对开发影响446对地点和设备影响447对经费开支影响 45不足 46技术条件方面可行性5可选择其它系统可行性51可选择系统方案152可选择系统方案26投资及效益分析61支出611基础建设投资612其它一次性支出613非一次性支出62收益621一次性收益622非一次性收益623不可定量收益63收益投资比64投资回收周期65敏感性分析7社会原因方面可行性71法律方面可行性72使用方面可行性8结论2.项目开发计划：是为软件项目实施方案制订出具体计划。项目开发计划应提前给管理部门，并作为开发阶段评审基础。编制项目开发计划止是用文件形式，把对于在开发过程中各项工作责任人员、开发进度、所需经费预算、所需软硬条件等问题做出安排记载下来，方便依据本计划开展和检验项目标开发工作。 其格式要求以下：1引言11编写目标12定义13参考资料2项目概述21工作内容22关键参与人员23产品231程序232方件233服务234非移交产品24验收标准25完成项目标最迟期限26本计划同意者和同意日期3实施计划31工作任务分配和人员分工32接口人员33进度34预算35关键问题4支持条件41计算机系统支持42需收用户负担工作43由外单位提供条件5专题计划关键点3.开发进度月报：开发进度月报编制目标是立即向相关部门汇报项目开发进度和情况，方便立即发觉和处理开发过程中出现问题，通常开发进度月报是以项目组单位每个月编写。假如被开发软件系统规模比较大，整个工程项目被划分给若干个分项目驵负担，开发进度月报将以分项目为单位搂月编写。 其格式要求以下：1标题2工程进度和状态21进度22状态3资源耗用和状态31资源耗用311工时313机时32状态4经费支出和状态41经费支出411支持性费用412设备购置费42状态5下30天工作计划6提议4.项目开发总结：软件项目开发完成以后，应该和项目实施计划对照，总坚固际实施情况，如进度、结果、资源利用、成本和投入人力。另外，还需对开发工作做出评价，总结经验和教训。项目开发总结汇报编制是为了总结本项目开发工作经验，说明实际取得开发结果和对整个开发工作各个方面评价。 其格式要求以下：1引言11编写目标12背景13定义14参考资料2实际开以结果21产品22关键功效和性能23基础步骤24进度25费用3开发工作评价31对生产效率评价32对产品质量评价33对技术方法评价34犯错原因分析4经验和教训5.模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来，每完成一个模块或一组亲密相关模块复制进编写一份，应该把全部模块开发卷宗聚集在一起。编写目标是统计和汇意低层次开发进度和结果，经便于对整个模块开发工作管理和复审，并为未来维护提供很有用技术信息。 1标题2模块开发情况表：其中模块开发情况表格式以下表：模块标识符模块描述性名称代码设计（计划开始日期实际开始日期）模块测试（计划开始日期实际开始日期）组装测试（计划开始日期实际开始日期）代码复查(日期/签字)源代码行数（估计/实际）目际模块大小（估计实际）项目责任人同意(日期/签字)3功效说明4设计说明5源代码清单6测试说明7复审结论三、软件开发测试文档：概要测试计划、具体测试计划、测试实施计划、测试分析汇报。1.概要测试计划：是软件项目实施计划中一项关键内容，应该在软件开发早期、即需求分析阶段制订。项计划应该定义被测试对象和测试目标，确定测试阶段和测试周期划分；制订测试人员、软硬件资源和测试进度等方面计划，要求软件测试方法，测试标准和支持环境和测试工具。2.具体测试计划：是针对子系统在特定测试阶段所要进行测试工作制订具体计划，它具体说明要求了测试小组各项测试任务，测试策略、任务分配和进度安排等。3.测试实施计划：测试人员测试实施计划是依据具体计划制订测试者测试具体实施计划。它要求了测试者在每一轮测试中负责测试内容，测试强度和工作进度等。测试实施计划是整个软件测试组成部分，是检验测试实际实施情况关键依据。其格式要求以下：1引言11编写目标12背景13定义14参考资料2计划21软件说明22测试内容23测试231进度安排232条件233测试资料234测试培训24测试3测试设计说明31测试311控制312输入313输出314过程32测试4评价准则41范围42数据整理43尺度4.测试分析汇报：测试工作完成以后，应该提交测试计划情况说明书，对测试结果加以分析，并提出测试结论性意见。其格式要求以下：1引言11编写目标12背景13定义14参考资料2测试概要3测试结果及发觉31测试132测试24对软件功效结论41功效1411能力412限制42功效25分析摘要51能力52缺点和限制53提议54评价6测试资源消耗四、用户文档：用户手册、操作手册。1.用户手册：用户手册编制是要使用非专门术语语言，充足地描述该软件系统所含有功效及基础使用方法，使用户（或潜在用户）经过本手册能够了解该软件用途，而且能够确定在什么情况下，怎样使用它。其格式要求以下：1引言11编写目标12背景13定义14参考资料2用途21功效22性能221精度222时间特征223灵活性23安全保密3运行环境31硬设备32支持软件33数据结构4使用过程41安装和初始化42输入421输入数据现实背景422输入格式423输入举例43输出431输出数据现实背景432输出格式433输出举例44文卷查询45犯错处理和恢复46终端操作2.操作手册：操作手册编制是为了向操作人员提供该软件每一个运行具体过程和相关知识，包含操作方法细节。其格式要求以下：1引言11编写目标12背景13定义14参考资料2软件征述21软件结构22程序表23文卷表3安装和初始化4运行说明41运行表42运行步骤43运行1431运行控制432操作控制433输入输出文卷434输出文段435输出文段复制436恢复过程44运行2.5很规过程6远程操作3.维护提议：软件产品投入运行以后，可能有修改、更正等问题。应该对存在问题、修改考虑和修改影响估量等作具体描述，写成维护修改提议、提交审批。其格式要求以下：1引言11综述12术语及缩写语13参考资料2程序结构描述3维护过程31开启32系统查询及事件汇报功效33硬件状态能功效描述4犯错处理及很规过程41系统重开启过程42严重故障时紧急处理43通常故障处理44数据备份工作5附录51附录一52附录二文档编制说明：文档标题用于说明项目标名称，文档专题用于说明本文档内容，文档编号和文档版本关键用于归档和检索。