软件开发文档模板-软件产品开发文件编制指南

〔产品治理〕品开发文件编制指南附录五国家标准《计算机软件产品开发文件编制指南》国家标《计算机软件产品开发文件编制指南〔GB8567—88〕是壹份指导性文件。它建议于软件的开发过程申编下述14个文件：可行性争论方案、工程开发打算、软件需求说明书、数据要求说明书、总体设计说明书、具体设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试打算、测试分析方案、开发进度表、工程开发总结。该指南给出了这 14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面具体介绍这14种文件的编写目的和内容要求。l、可行性争论方案可行性争论方案的目的是：说明该软件开发工程的实当下技术上、经济上和社会条上的可行性，论述为了合理地到达开发目标而可能选择的各种方案，说明且论证所选定的方案。可行性争论方案的编写内容见表l。表l可行性争论方案引言编写目的背景定义参考资料可行性争论的前提要求目标条件、假定和限制进展可行性争论的方法评价尺度对现有系统的分析数据流程和处理流程工作负荷消费开支人员设备局限性所建议的系统对所建议系统的说明数据流程和处理流程改进之处影响对设备的影响对软件的影响对用户单位机构的影响,4.4.4 对系统运行的影响对开发的影响对地点和设施的影响对经费开支的影响局限性技术条件方面的可行性可选择的其他系统方案可选择的系统方案1可选择的系统方案2投资及收益分析支出根本建设投资其他壹次性支出非壹次性支出收益壹次性收益非壹次性收益不行定量的收益收益/投资比投资回收周期敏感性分析社会条件方面的可行性法律方面的可行性使用方面的可行性结论2、工程开发打算编制工程开发打算的目的是用文件的形式，且于开发过程中各项工作的负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便依据本打算开展和检查工程的开发工作。编制内容要求如表2所示。表2工程开发打算引言编写目的背景定义参考资料工程概述工作内容主要参与人员产品及成果程序文件效劳非移交产品验收标准,2.5完成工程的最迟期限2.6本打算的审批者和批准者实施总打算工作任务的分析接口人员进度预算关键问题支持条件计算机统支持需要用户担当的工作需由外单位供给的条件专题打算要点3、软件需求说明书软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有壹个共同的理解，使之成为整个软件开发工作的根底。其内容要求见表3表3软件需求说明书引言编写目的背景定义参考资料任务概述目标用户的特点假定的约束需求规定对功能的规定对性能的规定,3.2.1 精度时间特性要求灵敏性输入输出要求数据治理要求故障处理要求其他特地要求运行环境规定设备支撑软件接口把握4、数据要求说明书数据要求说明书的编制目的是为了向整个软件开发时期供给关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。表4数据要求说明书引言编写目的背景定义参考资料数据的规律描述2.1静态数据2.2动态输入数据,2.3动态输出数据2.4内部生成数据2.5数据商定数据的采集要求的范围输入的担当者处理影响5、概要设计说明书概要设计说明书又称为总体设计说明书，编制目的是说明对工程系统的设计考虑，包括根本处理流程、组织构造、模块构造、功能配置、接口设计、运行设计、系统配置、数据构造设计和出错处理设计等，为程序的具体设计供给根底。其内容要求见表5表5概要设计说明书引言编写目的背景定义参考资料总体设计运行环境根本设计概念和处理流程构造功能需求和程序的关系人工处理过程尚未解决的问题接口设计用户接口3.2外部接口3.3内部接口运行设计运行模块组合运行把握运行时间系统数据构造设计规律构造设计要点物理构造设计要点数据构造设计要点系统出错处理设计出错信息补救措施系统维护设计6、具体设计说明书具体设计说明书又称为程序设计说明，编制目的是说明壹个软件系统各个层次中的每壹个程序〔模块〕的设计考虑。假设软件系统比较简洁，层次少，本文件能够不单独编写，有关内容可且入概要设计说明书。具体设计说明书的内容要求见表6表6具体设计说明书引言编写目的背景定义参考资料程序系统的组织构造程序1〔构造符〕设计说明程序描述功能性能输入项3.5输出项算法流程规律接口存储安排注释设计限制条件测试设计尚未解决的问题程序2〔标识符〕设计说明书7、数据库设计说明书数据库设计说明书的编制目的是对于设计中的数据的全部标识、规律结表7数据库设计说明书引言编写目的背景定义参考资料外部设计标识符和状态使用它的程序商定2.4特地指导支撑软件构造设计概念构造设计规律物理构造设计运用设计数据字典设计安全保密设计构和物理构造做出具体的设计规定。内容要求见表78、用户手册用户手册的编制是使用非专业术语的语言，充分地描述该软件系统所具有的功能及根本的使用方法。使用户通过本手册能够了解该软件的用途，且能够确定于什么状况下、如何使用它。具体的内容要求见表8表8用户手册引言编写目的背景定义参考资料用途功能性能精度时间特性灵敏性运行环境硬环境支撑软件3.3数据构造使用过程安全和初始化输入输入数据的现实背景输入格式输入举例输出输出数据的现实背景输出格式输出举例文卷查询出错处理和恢复终端操作9、操作手册操作手册的编制是为了向操作人员供给当软件每个运行的具体过程的有关学问，包括操作方法的细节。内容要求见表9表9操作手册引言编写目的背景定义参考资料软件概述软件的构造程序表文卷表安装和初始化运行说明运行表4.2运行步骤运行1(标识符)说明运行把握操作信息输出文段输出文段输出文段的复制启动恢复过程运行2(标识符)说明……格外规过程远程过程、模块开发卷宗模块开发卷宗是于模块开发过程中逐步编写出来的。每完成壹个模块或壹组亲热关联的模块，复审时编写出壹份，应当把全部的模块开发卷宗集合于壹起。编写的目的是记录和汇总低层次开发的进度和结果；以便于对整个系统开发工作进展治理的复审，且为将来的维护供给有用的技术信息。具体内容要求见表10、测试打算标题

表10模块开发卷宗模块开发状况表(见附表S10.10a)功能说明设计说明,5.源代码清单测试说明复审的结论模块标识符,,,模块的描述性名称,,,设计,打算开头日期,,,,实际开头日期,,,,打算完成日期,,,,实际完成日期,,,

表10a模块开发状况表代码模块测试,打算开头日期,,,,实际开头日期,,,,打算完成日期,,,,实际完成日期,,,组装测试,打算开头日期,,,,实际开头日期,,,,打算完成日期,,,,实际完成日期,,,代码复查日期/源代码行数,,,,,,,,目标模块大小,,,,,,,,工程负责人批准日期/这里所说的测试是指整个软件系统的组装测试和确认测试，本文件的编制是为了供给壹个对该软件的测试打算，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整体性方法及评价准则。具体内容见表11表11测试打算引言编写目的背景定义参考资料打算软件说明测试内容测试1(标识符)进度安排条件测试资料测试培训2.4测试2(标识符)……测试设计说明测试1(标识符)把握输入输出过程测试2(标识符)……评价准则范围数据整理尺度、测试分析方案测试分析方案的编写是为了把组装测试和确认测试的结果、觉察的问题以及分析结果写出成文件形式加以保存，具体编写内容要求见表12表12测试分析方案引言编写目的背景定义参考资料测试概要测试结果及觉察测试1(标识符)测试2(标识符)……对软件功能的结论4.1功能1(标识符)力气限制4.2功能2(标识符)……分析摘要力气缺陷和限制建议评价测试资源消耗、开发进度月报开发进度月报的编制目的是准时向有关治理部汇报工程开发的进度和状况,以便准时觉察和处理开发过程中消灭的问题。壹般来说，开发进度月报是以工程组为单位每月编写的，具体内容要求见表13表13开发进度月报标题工程进度和状态进度态度资源耗用和状态资源耗用工时机时,3.2状态经费支出和状态经费支出支出性费用设备购置费状态下个月的工作打算建议