计算机软件开发文档编写规范

目录封面格式……………………………………………………………………2一.可行性研究报告..............................................................................................................................................2二.项目开发计划..................................................................................................................................................4三.需求规格说明书..............................................................................................................................................5四.概要设计说明书..............................................................................................................................................6五.详细说明书......................................................................................................................................................7六.用户操作手册..................................................................................................................................................8七.测试计划........................................................................................................................................................10八.测试分析报告................................................................................................................................................11九.开发进度月报................................................................................................................................................12十.项目开发总结报告........................................................................................................................................13十一.程序维护手册............................................................................................................................................13十二.软件问题报告............................................................................................................................................16十三.软件修改报告............................................................................................................................................17计算机软件开发文档编写规范1封面格式文档编号版本号文档名称：项目名称：项目负责人：编写年月日校对年月日审核年月日批准年月日开发单位年月日计算机软件开发文档编写规范2一.可行性研究报告1引言1.1编写目的【阐明编写可行性研究报告的目的，指出读者的对象。】1.2项目背景【应包括：a所建议开发软件的名称；b项目的任务提出者、开发者、用户及实现软件的单位；c项目与其他软件或其他系统的关系。】1.3定义【列出文档中用到的专门术语的定义和缩写词的原文。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a项目经核准的计划任务书、合同或上级机关的批文；b与项目有关的已发表的资料；c文档中所引用的资料，所采用的软件标准或规范。】2可行性研究的前提2.1要求【列出并说明建议开发软件的基本要求，如a功能；b性能；c输出；d输入；e基本的数据流程和处理流程；f安全与保密要求；g与软件相关的其他系统；h完成期限。】2.2目标【可包括：a人力与设备费用的节省；b处理速度的提高；c控制精度或生产能力的提高；d管理信息服务的改进；e决策系统的改进；f人员工作效率的提高，等等。】2.3条件、假定和限制【可包括：a建议开发软件运行的最短寿命；b进行系统方案选择比较的期限；c经费来源和使用限制；d法律和政策方面的限制；e硬件、软件、运行环境和开发环境的条件和限制；f可利用的信息和资源；g建议开发软件投入使用的最迟时间。】2.4可行性研究方法2.5决定可行性的主要因素3对现有系统的分析3.1处理流程和数据流程3.2工作负荷3.3费用支出【如人力、设备、空间、支持性服务、材料等项开支。】3.4人员【列出所需人员的专业技术类别和数量。】3.5设备3.6局限性【说明现有系统存在的问题以及为什么需要开发新的系统。】计算机软件开发文档编写规范34所建议技术可行性分析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技术可行性评价【包括：a在限制条件下，功能目标是否能达到；b利用现有技术，功能目标能否达到；c对开发人员数量和质量的要求，并说明能否满足；d在规定的期限内，开发能否完成。】5所建议系统经济可行性分析5.1支出5.1.1基建投资5.1.2其他一次性支出5.1.3经常性支出5.2效益5.2.1一次性收益5.2.2经常性收益5.2.3不可定量性收益5.3收益/投资比5.4投资回收周期5.5敏感性分析【敏感性分析是指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。】6社会因素可行性分析6.1法律因素【如，合同责任、侵犯专利权、侵犯版权等问题的分析。】6.2用户使用可行性【如，用户单位的行政管理、工作制度、人员素质等能否满足要求。】计算机软件开发文档编写规范47其他可行性选择的方案【逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。8结论意见【结论意见可能是：a可着手组织开发；b需待若干条件（如资金、人力、设备等）具备后才能开发；c需对开发目标进行某些修改；d不能进行或不必进行（如技术不成熟，经济上不合算等）；e其他。】二.项目开发计划1引言1.1编写目的【阐明编写开发计划的目的，指出读者对象。】1.2项目背景【可包括：a项目的委托单位、开发单位主管部门；b该软件系统与其他系统的关系。】1.3定义【列出本档中用到的专门术语的定义和缩写词的原文。】1.4参考资料【可包括：a项目经核准的计划任务书、合同或上级机关的批文；b文档所引用的资料、规范等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】2项目概述2.1工作内容【简要说明项目的各项主要工作，介绍所开发软件的功能、性能等。若不编写可行性研究报告，则应在本节给出较详细的介绍。】2.2条件与限制【阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制。】2.3产品2.3.1程序【列出应交付的程序名称、使用的语言及存储形式。】2.3.2文档【列出应交付的文档】2.4运行环境【应包括硬件环境、软件环境。】2.5服务【阐明开发单位可向用户提供的服务。如人员的培训、安装、保修、维护和其他运行支持。】2.6验收标准3实施计划3.1任务分解【任务的划分及各项任务的负责人。】计算机软件开发文档编写规范53.2进度【按阶段完成的项目，用图表说明开始时间、完成时间。】3.3预算3.4关键问题【说明可能影响项目的关键问题，如设备条件、技术难点或其他风险因素。】4人员组织及分工5交付期限6专题计划要点【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。】三.需求规格说明书1引言1.1编写目的【阐明编写需求说明书的目的，指明读者对象。】1.2项目背景【应包括：a项目的委托单位、开发单位和主管部门；b该软件系统与其他系统的关系。】1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。】1.4参考资料【可包括：a项目经核准的计划任务书、合同或上级机关的批文；b项目开发计划；c文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日出版单位或资料来源。】2任务来源2.1目标2.2运行环境2.3条件与限制3数据描述3.1静态数据3.2动态数据【包括输入数据和输出数据。】3.3数据库描述【给出使用数据库的名称和类型。】3.4数据词典3.5数据采集4功能需求4.1功能划分计算机软件开发文档编写规范64.2功能描述5性能需求5.1数据精确度5.2时间特性【如响应时间、更新处理时间、数据转换与传输时运行时间等。】5.3适应性【在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。】6运行需求6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。】6.2硬件接口6.3软件接口6.4故障处理7其他需求【如可使用性、安全保密、可维护性、可移植性等。】四.概要设计说明书1引言1.1编写的目的【阐明编写概要设计说明书的目的，指明读者对象。】1.2项目背景【应包括：a项目的委托单位、开发单位和主管部门；b该软件系统与其他系统的关系。】1.3定义【列出本文档中所用到的专门术语的定义和缩写词的原意。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a项目经核准的计划任务书、合同或上级机关的批文；b项目开发计划；c需求规格说明书；d测试计划（初稿）；e用户操作手册（初稿）；f文档所用的资料、采用的标准或规范。】2任务概述2.1目标2.2运行环境2.3需求概述2.4条件与限制3总体设计计算机软件开发文档编写规范73.1处理流程3.2总体结构和模块外部设计3.3功能分配【表明各项功能与程序结构的关系。】4接口设计4.1外部接口【包括用户界面、软件接口与硬