软件开发文档(国标)
计算机软件产品开发文件编制指南GB 8567-88 Guidelines for computer software product development documentation
中华人民共和国国家标准UDC681．3
引言
1 目的
一项计算机软件的筹划、研制及实现，构成一个软件开发项目。一个软件开发项目的进行，一般需要在人力和自动化资源等方面作重大的投资。为了保证项目开发的成功，最经济地花费这些投资，并且便于运行和维护，在开发工作的每一阶段，都需要编制一定的文件。这些文件连同计算机程序及数据一起，构成为计算机软件。文件是计算机软件中不可缺少的组成部分，它的作用是：
a．作为开发人员在一定阶段内的工作成果和结束标志；
b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转换成“可见的”文字资料。以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是否已达到，还将继续耗用资源的种类和数量；
C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；
d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作；
e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。
换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。
计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类则是应编制的技术资料或技术管理资料，可称之为文件。本指南规定软件文件的编制形式，并提供对这些规定的解释。本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。
2 范围
本指南是一份指导性文件。本指甫建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。这十四种文件是：
可行性研究报告；
项目开发计划；
软件需求说明书；
数据要求说明书；
概要设计说明书；
详细设计说明书；
数据库设计说明书；
用户手册；
操作手册；
模块开发卷宗；
测试计划；
测试分析报告；
开发进度月报；
项目开发总结报告。
本指南将给出开发过程中建议产生的这十四种文件的编制指导，同时，本指南也是这十四种文件的编写质量的检验准则。但是，本指南并未涉及软件开发过程中如何填写工作表格的问题。
一般地说，一个软件总是一个计算机系统（包括硬件、固件和软件）的组成部分。鉴于计算机系统的多样性，本指南一般不涉及整个系统开发中的文件编制问题，本指南仅仅是软件开发过程中的文件编制指南。
3 文件的使用者
对于使用文件的人员而言，他们所关心的文件的种类，随他们所承担的工作而异。
管理人员：可行性研究报告，
项目开发计划，
模块开发卷宗，
开发进度月报，
项目开发总结报告；
开发人员：可行性研究报告，
项目开发计划，
软件需求说明书，
数据要求说明书，
概要设计说明书，
详细设计说明书，
数据库设计说明书，
测试计划，
测试分析报告；
维护人员：设计说明书，
测试分析报告，
模块开发卷宗；
用户：用户手册，
尽管本指南提出了在软件开发中文件编制的要求，但并不意味着这些文件都必须交给用户。一项软件的用户应该得到的文件的种类由供应者与用户之间签订的合同规定。
第一篇文件的编制指导
4 软件生存周期与各种文件的编制
一项计算机软件，从出现一个构思之日起，经过这项软件开发成功投入使用，直到最后决定停止使用，并被另一一项软件代替之时止，被认为是该软件的一个生存周期。一般地说这个软件生存周期可以分成以下六个阶段：可行性与计划研究阶段需求分析阶段
设计阶段
实现阶段
测试阶段
运行与维护阶段
在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。
在需求分析阶段内，由系统分析人员对被设计的系统进行系统分析，确定对该软件的各项功能、性能需求和设计约束，确定对文件编制的要求，作为本阶段工作的结果，一般地说，软件需求说明书、数据要求说明书和初步的用户手册应该编写出来。
在设计阶段内，系统设计人员和程序设计人员应该在反复理解软件需求的基础上，提出多个设计，分析每个设计能履行的功能并进行相互比较，最后确定一个设计，包括该软件的结构、模块的划分、功能的分配以及处理流程。在被设计系统比较复杂的情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步骤。在一般情况下，应完成的文件包括：概要设计说明书、详细设计说明书和测试计划初稿。
在实现阶段内，要完成源程序的编码、编译（或汇编）和排错调试得到无语法错的程序清单，要开始编写模块开发卷宗，并且要完成用户手册、操作手册等面向用户的文件的编写工作，还要完成测试计划的编制。
在测试阶段，该程序将被全面地测试，已编制的文件将被检查审阅。一般要完成模块开发卷宗和测试分析报告，作为开发工作的结束，所生产的程序、文件以及开发工作本身将逐项被评价，最后写出项目开发总结报告。
在整个开发过程中（即前五个阶段中），开发集体要按月编写开发进度月报。
在运行和维护阶段，软件将在运行使用中不断地被维护，根据新提出的需求进行必要而且可能的扩充和删改。
对于一项软件而言，其生存周期各阶段与各种文件编写工作的关系可见表互，其中
有些文件的编写工作可能要在若干个阶段中延续进行。
表1软件生存周期各阶段中的文件编制
5 文件编制中的考虑因素
文件编制是一个不断努力的工作过程。是一个从形成最初轮廓，经反复检查和修改，直到程序和文件正式交付使用的完整过程。其中每一步都要求工作人员做出很大努力。要保证文件编制的质量，要体现每个开发项目的特点，也要注意不要花太多的人力。为此，编制中要考虑如下各项因素。
5．1 文件的读者
每一种文件都具有特定的读者。这些读者包括个人或小组、软件开发单位的成员或
些文件的内容来进行工作，例如设计、编写程序、测试、使用、维护或进行计划管理。因此，这些文件的作者必须了解自己的读者，这些文件的编写必须注意适应自己的特定读者的水平、特点和要求。
5．2 重复性
本指南第二篇中将列出的这十四种文件的内容要求中，显然存在某些重复。较明显的重复有两类。引言是每一种文件都要包含的内容，以向读者提供总的梗概。第二类明显的重复是各种文件中的说明部分，如对功能性能的说明、对输入和输出的描述、系统中包含的设备等。这是为了方便每种文件各自的读者，每种产品文件应该自成体系，尽量避免读一种文件时又不得不去参考另一种文件。当然，在每一种文件里，有关引言、说明等同其他文件相重复的部分，在行文上、在所用的术语上、在详细的程度上，还是应该有一些差别，以适应各种文件的不同读者的需要。
5．3 灵活性
鉴于软件开发是具有创造性的脑力劳动，也鉴于不同软件在规模上和复杂程度上差别极大，本指南认为在文件编制工作中应允许一定的灵活性。这种灵活性表现在如下各款。
5．3．1 应编制的文件种类
尽管本指南认为在一般情况下，一项软件的开发过程中，应产生的文件有十四种，然而针对一项具体的软件开发项目，有时不必编制这么多的文件，可以把几种文件合并成一种。一般地说，当项目的规模、复杂性和成败风险增大时，文件编制的范围、管理手续和详细程度将随之增加。反之，则可适当减少。为了恰当地掌握这种灵活性，本指南要求贯彻分工负责的原则，这意味着：
a: 一个软件开发单位的领导机构应该根据本单位经营承包的应用软件的专业领域和本单位的管理能力，制定一个对文件编制要求的实施规定，主要是：在不同的条件下，应该形成哪些文件？这些文件的详细程度？该开发单位的每一个项目负责人，必须认真执行这个实施规定。这种规定的两个例子可见本指南的附录o（参考件）；
b．对于一个具体的应用软件项目，项目负责人应根据上述实施规定，确定一个文件编制计划，主要包括:
(1)应该编制哪几种文件，详细程度如何？
（2）各个文件的编制负责人和进度要求；
（3）审查、批准的负责人和时间进度安排；
（4）在开发时期内，各文件的维护、修改和管理的负责人，以及批准手续。
每项工作必须落实到人。
这个文件编制计划是整个开发计划的重要组成部分；
C．有关的设计人员则必须严格执行这个文件编制计划。
5．3．2 文件的详细程度
从同一份提纲起草的文件的篇幅大小往往不同，可以少到几页，也可以长达几百页。对于这种差别本指南是允许的。此详细程度取决于任务的规模、复杂性和项目负责人对该软件的开发过程及运行环与所需要的详细程度的判断。
5．3．3 文件的扩展
当被开发系统的规模非常大（例如源码超过一百万行）时，一种文件可以分成几卷编写，可以按其。每一个系统分别编制，也可以按内容划分成多卷，例如：
项目开发计划可能包括：质量保证计划，
配置管理计划，
用户培训计划，
安装实施计划；
系统设计说明书可分写成：系统设计说明书，
子系统设计说明书；
程序设计说明书可分写成：程序设计说明书，
接口设计说明书，
版本说明；
操作手册可分写成：操作手册，
安装实施过程；
．测试计划可分写成：测试计划，
测试设计说明，
测试规程，
测试用例；
测试分析报告可分写成：综合测试报告，
验收测试报告；
项目开发总结报告亦可分写成项目开发总结报告和资源环境统计。
5．3．4 节的扩张与缩并
在有些文件中，可以使用本指南所提供的章、条标题，但在条内又存在一系列需要分别讨论的因素本指南认为，所有的条都可以扩展，可以进一步细分，以适应实际需
要。反之，如果章条中的有些细节；非必需，也可以根据实际情况缩并。此时章条的编号应相应地改变。
5．3．5 程序设计的表现形式
本指南对于程序的设计表现形式并未作出规定或限制，可以使用流程图的形式、判定表的形式，1 可以使用其他表现形式，如程序设计语言（PDL）、问题分析图（PAD）等。
5．3．6 文件的表现形式
本指南对于文件的表现形式亦未作出规定或限制，可以使用自然语言，也可以使用形式化语言。
5．3．7 文件的其他种类
当本指南中规定的文件种类尚不能满足某些应用部门的特殊需要时，他们可以建立一些特殊的文件种类要求，例如软件质量保证计划、软件配置管理计划等，这些要求可以包含在本单位的文件编制实施规定中。
6 文件编制的管理工作
文件编制工作必须有管理工作的配合，才能使所编制的文件真正发挥它的作用。文件的编制工作实际上贯穿于一项软件的整个开发过程，因此，对文件的管理必须贯穿于整个开发过程。在开发过程中必须进行的管理工作是以下四条。
6．1文件的形成
开发集体中的每个成员，尤其是项目负责人，应该认识到：文件是软件产品的必不可少的组成部分；在软件开发过程的各个阶段中，必须按照规定及时地完成各种产品文件的编写工作；必须把在一个开发步骤中作出的决定和取得的结果及时地写入文件；开发集体必须及时地对这些文件进行严格的评审；这些文件的形成是各个阶段开发工作正式完成的标志。这些文件上必须有编写者、评审者和批准者的签字，必须有编写、评审完成的日期和批准的日期。
6．2文件的分类与标识
在软件开发的过程中，产生的文件是很多的，为了便于保存、查找、使用和修改，应该对文件按层次地加以分类组织。一个软件开发单位应该建立一个对本单位文件的标识方法，使文件的每一页都具有明确的标识。例如可以按如下四个层次对文件加以分类和标识。
a．文件所属的项目的标识；
b．文件种类的标识；
C．同一种文件的不同版本号；
d．页号。
此外，对每种文件还应根据项目的性质，划定它们各自的保密级别，确定他们各自的发行范围。
6．3文件的控制
在一项软件的开发过程中，随着程序的逐步形成和逐步修改，各种文件亦在不断地产生、不断地修改或补充。因此，必须加以周密的控制，以保持文件与程序产品的一致性，保持各种文件之间的一致性和文件的安全性。这种控制表现为：a．就从事一项软件开发工作的开发集体而言，应设置一位专职的文件管理人员（接口管理工程师或文件管理员）；在开发集体中，应该集中保管本项目现有全部文件的主文本两套，由该文件管理人员负责保管；
b．每一份提交给文件管理人员的文件都必须具有编写人、审核人和批准人的签字；
C．这两套主文本的内容必须完全一致；其中有一套是可供出借的，另一套是绝对不能出借的，以免发生万一；可出借的主文本在出借时必须办理出借手续，归还时办理注销出借手续；
d．开发集体中的工作人员可以根据工作的需要，在本项目的开发过程中持有一些文件，即所谓个人文件，包括为使他完成他承担的任务所需要的文件，以及他在完成任务过程中所编制的文件；但这种个人文件必须是主文本的复制品，必须同主文本完全一致，若要修改，必须首先修改主文本；
e．不同开发人员所拥有的个人文件通常是主文本的各种子集；所谓子集是指把主文本的各个部分根据承担不同任务的人员或部门的工作需要加以复制、组装而成的若干个文件的集合；文件管理人员。应该列出一份不同子集的分发对象的清单，按照清单及时把文件分发给有关人员或部门；
f．一份文件如果已经被另一份新的文件所代替，则原文件应该被注销；文件管理人中要随时整理主文本，及时反映出文件的变化和增加情况，及时分发文件；
g．当一个项目的开发工作临近结束时，文件管理人员应逐个收回开发集体内每个成
文本更详细，或同主文本的内容有所不同，必须认真监督有关人员进行修改，使主文本能真正反映实际的开发结果。
6．4文件的修改管理
在一个项目的开发过程中的任何时刻，开发集体内的所有成员都可能对开发工作的已有成果——文件，提出进行修改的要求。提出修改要求的理由可能是各种各样的，进行修改而引起的影响可能很小，也可能会牵涉到本项目的很多方面。因此，修改活动的进行必须谨慎，必须对修改活动的进行加以管理，必须执行修改活动的规程，使整个修改活动有控制地进行。
修改活动可分如下五个步骤进行：
a．提议开发集体中的任何一个成员都可以向项目负责人提出修改建议，为此应该填写一份修改建议表，说明修改的内容、所修改的文件和部位、以及修改理由；
b．评议由项目负责人或项目负责人指定的人员对该修改建议进行评议，包括审查该项修改的必要性、确定这一修改的影响范围、研究进行修改的方法、步骤和实施计划；
c．审核一般由项目负责人进行审核，包括核实修改的自的和要求、核实修改活动将带来的影响、审核修改活动计划是否可行；
d．批准在一般情况下，批准权属于该开发单位的部门负责人；在批准时，主要是决断修改工作中各项活动的先后顺序及各自的完成日期，以保证整个开发工作按原定计划日期完成；
e．实施由项目负责人按照已批准的修改活动计划，安排各项修改活动的负责人员进行修改，建立修改记录、产生新的文件以取代原有文件、最后把文件交文件管理人员归档，并分发给有关的持有者。
第二篇各种文件的内容要求
本篇将对引言中提到的十四种文件提供内容要求，作为文件编制的技术标准。
7 可行性研究报告
可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。
可行性研究报告的编写内容要求如下：
7．1C1编写目的
7．1．2背景
7．1．3定义
7．1．4参考资料7
7．2可行性研究的前提
7．2．1要求
7．2．2目标
7．2．3条件、假定和限制
7．2．4进行可行性研究的方法
7．2．5评价尺度
7．3对现有系统的分析
7．3．1数据流程和处理流程
7．3．2工作负荷
7．3．3费用开支
7．3．4人员
7．3．5设备
7．3．6局限性
7．4所建议的系统
7．4．1对所建议系统的说明
7．4．2数据流程和处理流程
7．4．3改进之处
7．4．4影响
7．4．4．1对设备的影响
7．4．4．2对软件的影响
7．4．4．3对用户单位机构的影响 7．4．4．4对系统运行的影响
7．4．4．5对开发的影响
7．4，4．6对地点和设施的影响 7．4．4．7对经费开支的影响
7．4．5局限性
7．4．6技术条件方面的可行性7．5可选择的其他系统方案
7．5．1可选择的系统方案1
7．5．2可选择的系统方案2 ．．．．．．
7．6投资及收益分析
7．6．1支出
7．6．1．2其他一次性支出
7．6．1．3非一次性支出
7．6．2收益
7．6，2．1一次性收益
7．6．2．2非一次性收益
7．6．2．3不可定量的收益
7．6．3收益／投资比
7．6．4投资回收周期
7．6．5敏感性分析
7．7社会条件方面的可行性
7．7．1法律方面的可行性
7．7．2使用方面的可行性
7．8结论
8 项目开发计划
编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下：
8．1引言
8．1．1编写目的
8．1．2背景
8．1．3定义
8．1．4参考资料
8．2项目概述
8．2．1作内容
8．2．2主要参加人员
8．2．3产品及成果
8．2．3．1程序
8．2．3．2文件
8．2．3．3服务
8．2．3．4非移交产品
8．2．4验收标准
8．．2．5完成项目的最迟期限
8．2．6本计划的审查者与批准者
8．3实施总计划
8．3．2接口人员
8．3．3进度
8．3．4预算
8．3．5关键问题
8．4支持条件
8．4．1计算机系统支持
8．4．2需要用户承担的工作
8．4．3需由外单位提供的条件
8．5专题计划要点
9 软件需求说明书
软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下：9．1引言
9．1．1编写目的
9．1．2背景
9．1．3定义
9．1．4参考资料
9．2任务概述
9．2．1目标
9．2．2用户的特点
9．2．3假定与约束
9．3需求规定
9．3．1对功能的规定
9．3．2对性能的规定
9．3．2．1精度
9．3．2．2时间特性耍求
9．3．2．3灵活性
9．3．3输入输出要求
9．3．4数据管理能力要求
9．3．5故障处理要求
9．3．6其他专门要求
9．4运行环境规定
9．4．1设备
9．4．3接口
9．4．4控制
10 数据要求说明书
数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下：
10．1引言
10．1．1编写目的
10．1．2背景
10．1．3定义
10．1．4参考资料
10．2数据的逻辑描述
10．2．1静态数据
10．2．2动态输入数据
10．2．3动态输出数据
10．2．4内部生成数据
10．2．5数据约定
10．3数据的采集
10．3．1要求和范围
10．3．2输入的承担者
10．3．3处理
10．3．4影响。
11 概要设计说明书
概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下：
11．1引言
11．1．1编写目的
11．1．2背景
11．1．3定义
11．1．4参考资料
11．2．1需求规定
11．2．2运行环境
11．2．3基本设计概念和处理流程
11．2．4结构
11．2．5功能需求与程序的关系
11．2．6人工处理过程
11．2．7尚未解决的问题
11．3接口设计
11．3．1用户接口
11．3．2外部接口
11．3．3内部接口
11．4运行设计
11．4．1运行模块组合
11．4．2运行控制
11．4．3运行时间
11．5系统论据结构设计
11．5．1逻辑结构设计要点
11．5．2物理结构设计要点
11．5．3数据结构与程序的关系
11．6系统出错处理设计
11．6．1出错信息
11．6．2补救措施
11．6 3系统维护设计
12详细设计说明书
详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。对详细设计说明书的内容要求如下：
12．1引言
12．1．1编写目的
12．1．2背景
12．1．3定义
12．1．4参考资料
12．2程序系统的组织结构
12．3．1程序描述
12．3．2功能
12．3．3性能
12．3．4输入项
12．3．5输出项
12．3．6算法
12．3．7流程逻辑
12．3．8接口
12．3．．9存储分配
12．3．10注释设计
12．3．11限制条件
12．3．12测试计划．
12．3．13尚未解决的问题
12．4程序2（标识符）设计说明
．．．．．．
13 数据库设计说明书
数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。其内容要求如下：
13．1引言
13．1．1编写目的
13．1．2背景
13．1．3定义
13．1．4参考资料
13．2外部设计
13．2．1标识符和状态
13．2．2使用它的程序
13．2．3约定
13．2．4专门指导
13．2．5支持软件
13．3结构设计
13．3．1概念结构设计
13．3．2逻辑结构设计
13．3．3物理结构设计
13．4运用设计
13．4．1数据字典设计
用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。具体的内容要求如下：
14．1引言
14．1．1编写目的
14．1．2背景
14．1．3定义
14．1．4参考资料
14．2用途
14．2．1功能
14．2．2性能
14．2．2．1精度
14．2．2．2时间特性
14．2．2．3灵活性
14．2．3安全保密
14．3运行环境
14．3．1硬设备
14．3．2支持软件
14．3．3数据结构
14．4使用过程
14．4．1安装与初始化
14．4．2输入
14．4．2．1输入数据的现实背景
14．4．2．2输入格式
14．4．2．3输入举例
14．4．3输出
14．4．3．1输出数据的现实背景
14．4．3．2输出格式
14．4．3．3输出举例
14．4．4文卷查询
14．4．5出错处理与恢复
14．4．6终端操作
操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节。具体的内容要求如下：
15．1引言
15．1．1编写目的
15．1．2背景
15．1．3定义
15．1．4参考资料
15．2软件概述
15．2．1软件的结构
15．2．2程序表
15．2．3文卷表
15．3安装与初始化
15．4运行说明
15．4．1运行表
15．4．2运行步骤
15．4．3运行1（标识符）说明
15．4．3．1运行控制
15．4．3．2操作信息
15．4．3．3输入一输出文卷
15．4．3．4输出文段
15．4．3．5输出文段的复制
15．4．3．6启动恢复过程
15．4．4运行2（标识符）说明
．．．．．．
15．5非常现过程
15．6远程操作
16 模块开发卷宗
模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。具体的内容要求如下：
16．1标题
16．2模块开发情况表（见下表）
模块开发情况表
16．3功能说明
16．4设计说明
16．5源代码清单
16．6测试说明
16．7复审的结论
17测试计划
这里所说的测试，主要是指整个程序系统的组装测试和确认测试。本文件的编制是为
了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。具体的内容要求如下：
17．1引言
17．1．1编写目的
17．1．2背景
17．1．3定义
17．1．4参考资料
17．2计划
17．2．1软件说明
17．2．2测试内容
17．2．3测试1（标识符）
17．2．3．1进度安排
17．2．3．2条件
17．2．3．3测试资料
17．2．3．4测试培训
17．2．4测试2（标识符）
．．．．．．
17．3测试设计说明
17．3．1测试l（标识符）
17．3．1．1控制
17．3．1．2输入
17．3．1．3输出
17．3．1．4过程
17．3．2测试2（标识符）
．．．．．．．
17．4评价准则
17．4．1范围
17．4．2数据整理
17．4．3尺度
18 测试分析报告
测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载，具体的内容要求如下：
18．1引言
18．1．1编写目的
18．1．2背景
18．1．4参考资料
18．2测试概要
18．3测试结果及发现
18．3．1测试1（标识符）
18．3．2测试2（标识符）
．．．．．．
18．4对软件功能的结论
18．4．1功能1（标识符）
18．4．1．1能力
18．4．1．2限制
18．4．2功能2（标识符）
18．5分析摘要
18．5．1能力
18．5．2缺陷和限制
18．5．3建议
18．5．4评价
18．6测试资源消耗
19 开发进度月报
开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。一般地，开发进度月报是以项目组为单位每月编写的。如果被开发的软件系统规模比较大，整个工程项目被划分给若干个分项目组承担，开发进度月报将以分项目组为单位按月编写。具体的内容要求如下：19．1标题
19．2工程进度与状态
19．2．1进度
19．2．2状态
19．3资源耗用与状态
19．3．1资源耗用
19．3．1．1工时
19．3．1．2机时
19．3．2状态
19．4经费支出与状态
19．4．1经费支出
19．4．1．1支持性费用
19．4．1．2设备购置费
(国内标准)GB-软件开发主要文档编写规范
231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 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. 控制精度或生产能力的提高。
软件设计文档国家标准GB8567
软件设计文档国家标准GB8567-88 一、文档编写标准化 在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。 完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。 1、可行性分析报告 说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 2、项目开发计划 为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 3、软件需求说明书（软件规格说明书） 对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 4、概要设计说明书 是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。 5、详细设计说明书 着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 6、用户操作手册 详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。 7、测试计划 包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告 测试计划的执行情况，对测试结果的分析，提出测试结论。 9、开发进度月报 按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。 10、项目开发总结报告 项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。 11、软件维护手册 主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告 记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告 软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。 二、可行性分析报告的撰写要求 可行性研究报告的编写内容要求如下： 1 引言
软件开发文档范例
文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日 校对：___________ ____年__月__日 审核：___________ ____年__月__日 批准：___________ ____年__月__日
开发单位：传讯网络信息 ________________________ 系统规格说明 一、系统功能和目标： 随着因特网的不断普及，国的用户数呈指数级增长。作为因特网最为常用的电子系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的系统。传讯网络信息自主设计开发了适合中国国情的免费电子系统，用以解决这一日益突出的问题。CHINATION 免费电子系统是专为免费电子服务商、企业集团设计的电子系统。 Chination免费电子系统的设计目标是立足于一个高度集成的、功能强大、技术先进的电子系统。高度集成意味着本系统将把硬盘软件集成在一起。系统是基于LINUX下的，硬盘和软件的集成使得系统具有绝对的安装优势。功能强大意味着系统的实用性，功能的全面性，系统的安全性和可靠性。技术先进意味着将最新版本的LDAP，IMAP，POSTFIX，MYSQL，APACHE和PHP的巧妙结合。 本系统要实现的主要功能有：
1．用户申请注册功能。用户通过申请可以得到一个自己命名的信箱，容量大小为10M。 2．用户忘记密码处理功能。用户忘记密码可以通过注册时设置的密码提示问题来重设密码。 3．用户收功能。它包括SMTP收、POP3取和WWW读三种方式。 4．用户发功能。它包括SMTP发、WWW直接发送、暗送、抄送、定时发送。 5．用户信件处理功能。系统初始设置4个文件夹来分类处理信件：收件箱、发件箱、草稿箱和垃圾箱。用户还可以自己建立新的文件夹。信件在各个信箱之间可以相互移动。 6．用户查找功能。用户可以使用查找功能通过查找信件主题或信件容来找到自己需要的信件。 7．用户信箱配置设置。它包括个人资料更改、密码更改、参数设置、POP3服务器设置、过滤器设置、自动转信、定时发信、签名设置。 8．管理员管理用户和信箱功能。包括输入（增删改）、查询、统计、报表。系统性能参数设置。 9．广播功能。它用于公司定期向一定的用户发送信息，由于一般的用户数有一定数量，所以必须用数据库管。 二、可行性分析 1．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于传讯网络信息是国外多家公司并行处理产品的代理商，而且自己本身拥有ALPHA机等先进设备，所以有足够能力开发出先进的电子系统。软件方面，我们拟采用以下几种软件： 1）操作系统用LINUX。Linux作为一个优秀的网络操作系统，它的发行版本中集成了大量的网络应用软件，如Web服务器(apache)、Ftp服务器(wu-ftp)、服务器(sendmail+imap4)、SQL数据库(postgresql)等，可以快速的构建Intranet环境，并且也有精致的收发程序(metamail)和强大的Web 服务器端开发工具(PHP4)。当你配置好sendmail并激活imapd后，你的Linux用户都可以使用Outlook等客户端软件进行收发，只要通过将它们集中进行应用，便可以实现一个简单的Webmail 服务器的功能。但是随着自由软件的不断开发，要构架一个好的电子系统，就面临着软件选择是否适当、性能是否比别人好的问题。下面列出我们所使用的软件。 2）本系统壳软件用imap。有几种方法可以构造电子系统的壳：共享文件系统的策略，基于局域网的专用协议，X.400P7协议和因特网消息存取协议。而基于INTERNET的协议主要有：POP (Post Office Protocol), DMSP (Distributed Mail System Protocol), 和IMAP (Internet Message Access Protocol).POP是最原始，最为人们所知的一种。DMSP仅局限于一个简单应用——PCMAIL，它的优点主要在于对脱机状态操作的支持。IMAP不但继承了POP和DMSP的优点，而且超越了他们的缺点，提供了三种状态下对远程信箱的访问：在线、不连接和脱机状态。在脱机状态，可以发送到一个共享的服务器，但是客户并不是马上全部把它们COPY过去之后在服务器上删掉它们，
软件开发文档规范
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准
三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明
软件工程国家标准
GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 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. 控制精度或生产能力的提高。
软件开发文档模板
软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资
1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
软件系统开发规范
系统开发规范 1、数据库使用规范 1.1服务器上有关数据库的一切操作只能由服务器管理人员进行。 1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。 1.3原则上每一个频道只能建一个库，库名与各频道的英文名称相一致，库中再包含若干表。比较大的、重点的栏目可以考虑单独建库，库名与栏目的英文名称相一致。 1.4命名： （1）数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名（尽量避免使用汉语拼音），对于一个单词难以表达的，可以考虑用多个单词加下划线（_）连接（不能超过四个单词）命名。 （2）所有的名称必须统一使用英文小写字母。 （3）所有的名称起始和结尾不能使用下划线（_）。 （4）所有的名称不能包含26个英文小写字母和下划线（_）以外的其他字符。 1.5不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。 2、文档规范 所有的项目必须有相关的文档说明（可以是电子文档）。文档应包含如下内容： （1）项目名称。 （2）项目小组名单，项目负责人。 （3）项目开发起始时间和结束时间。 （4）项目内容描述。 （5）项目位置。（在哪个频道、哪个栏目） （6）与项目有关的程序文件名（含路径名），文件内容及实现的功能描述。 （7）完整的程序流程图。
（8）数据库、表、视图、索引的名称，用途。字段的名称、类型、长度、用途，必须附上相关的SQL语句。 3、源代码与页面嵌套规范 3.1源代码： （1）使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途。 （2）自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。 （3）程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。 （5）所有的注释文字一律使用简体中文。 3.2 HTML页面嵌套： （1）网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数（或高度）等，并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。 （2）软件开发人员和编辑人员可以根据情况协商，将页面文件及图片与程序独立存放在各自的服务器上，页面改版和修改程序独立进行。 （3）使用include技术将分割开的HTML页面分别嵌入程序代码中，要求做到修改HTML页面时无须改写程序，而修改程序时不会影响HTML页面效果，将页面改版和修改程序两项工作分别独立。 （4）页面和程序嵌套以后不能破坏原HTML页面的整体显示效果，字体、字号、颜色等应尽量保持原HTML页面的风格。 （5）动态生成的页面的各项指标（如图片大小、页面宽度、高度、页面文件的字节数等）应符合本公司网页设计方面的要求。 4、测试规范（软件部分） 对于较大的项目应成立相应的测试小组，小组成员由软件开发人员、网页设计人员、技术人员、
软件开发过程管理规范
软件开发过程管理规范文件管理序列号：[K8UY-K9IO69-O6M243-OL889-F88688]
0 引言 如果要提高软件开发人员的开发质量，必须有相应的考核制度，有了制度后才能推动开发人员想方设法改善自已的开发质量。目前研发对软件开发的过程缺乏细粒度的度量，所以不能依据有效的度量数据来考核开发人员的工作绩效，大部份只是凭考核人主观意志来考核，不能形成对被考核人有效的说服力。此绩效考核办法旨在结合实际情况合理客观地评价开发效率和质量。 1 目的 对软件开发的过程所产生的软件项的质量和过程进行定量的评价，用评价的结果指导软件的开发过程，不断地提高软件开发质量水平，并依据度量记录来考核软件开发人员的工作绩效。 2 软件项包括 1）技术文档：主要包括：可行性分析报告、需求分析报告、软件功能规格说明、开发计划、系统设计报告、测试文档、用户手册、总结报告等； 2）计算机程序。 3 度量数据的来源 1）项目计划； 2）评审报告； 3）测试报告； 4）问题报告； 5）软件维护记录； 4 质量度量
4.1 度量指标 主要根据各类软件项检查表的检查指标来确定，例如，软件需求规格说明书检查表（见附录1），有10个检查指标，则根据具体项目检查侧重点不同，可从中选择相应的检查指标作为度量指标。 4.2 质量等级 1）软件项的质量等级的确定根据度量综合指标进行。 2）度量综合指标计算公式为：Total = ∑QiMi。 3）其中i=1,2,...n代表指标数量； 4）Q代表度量的指标； 5）M代表度量的指标Q在整个指标体系中所占的权重系数，对不同的开发项目可能不同，此系数根据开发的不同着重点给出。 度量指标权重系数表： 序号指标权重 1 指标1 权数1 2 指标2 权数2 3 指标3 权数3 4 指标4 权数4 5 指标5 权数5 加权平均分 1.0 6）质量评价：一般地，根据度量综合指标值，有以下评分标准。 质量评价计分标准表 序号得分质量评价
软件开发技术标准
系统中涉及的所有规范、标准或材料规格（包括一切有效的补充或附录）均采用最新版本，即以招标方与投标方签订供货合同之日作为采用最新版本的截止日期。若发现本规范书与参照的文献之间有不一致之处，我方向贵方书面指明，并由贵方确定采用哪一个规范。 我方所有设备的设计，制造，检查，试验及特性除木规范中规定的特别标准外，都遵照适用的最新版中国国家标准（GB）以及国际单位制（SI） O 我方提出的等同标准应不低于贵方要求的标准并征得贵方的认可，我方应遵循的标准至少包括： 《中华人民共和国计算机信息系统安全保护条例》 GB2887-89 计算站场地技术条件 GB/T 9361-1988 计算机场地安全要求 GB4943 —90 信息技术设备（包扌舌电气事务设备）的安全 GB/T -1995 中华人民共和国计算机信息安全保护条例 GB18030-2000 信息交换用汉字编码字符集基本集的扩充 GB1526-89信息处理一数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文字编制符及约定
GB8566计算机软件开发规范 GB9385计算机软件需求说明编制指南 GB9386计算机软件测试文件编制规范 GB/T13502信息处理、程序构造及其表示法的约定 GB/T14085信息处理系统计算机系统配置图符号及约定GB10112确立术语的一般原则与方法 GB/T13725确立术语数据库的一般原则与方法 SJ/T11293企业信息化技术规范 GB/T12504-90计算机软件配置管理计划规范 GB/T13702-92计算机软件分类与代码 GB/T14079-93软件工程术语 GB/T15532-1995计算机软件单元测试 GB/T 14394-1993《计算机软件可靠性和可维护性规范》GB/T 2887-1989《计算机软件质量保证规范》 GB/T 8566-2000《信息技术软件生成期过程》
软件项目开发计划规范
软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的； ? 说明编写这份项目开发计划的目的； ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 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工作任务的分门与人员分工
软件研发管理制度
武汉新英赛研发管理 第一节 软件研发岗位职责 一、软件研发部经理岗位职责 软件研发部经理在总经理或主管副总的领导下, 全面负责软件研发部的日常管理， 组织 开展软件研发与测试工作，完成企业研发目标和经营目标。其具体职责如表 二、高级研发工程师岗位职责 高级研发工程师参与建立研发工作标准与规范，协助部门经理组织完成软件研发工作, 管理软件研发项目，改良升级进行软件。其具体职责如表 8-1所示。 8-2所示。
表8-2 高级研发工程师岗位职责 三、软件研发工程师岗位职责 软件研发工程师协助高级工程师进行软件的设计与开发，收集整理相关行业信息与资料，为软件产品决策提供依据。其具体职责如表8-3所示。
四、软件测试工程师岗位职责 软件测试工程师主要负责软件测试工作, 根据软件产品规格和测试需求，编写测试方案、测试用例、测试脚本软件等。其具体职责如表8-4所示。 第二节软件研发管理制度 六、软件研发费用管理制度 第1章总则 第1条目的。 为了加强软件研发费用管理，规范资金的使用，减少公司不必要的损失，根据公司的实
际情况，特制定本制度。 第2 条研发费用管理原则。 1．计划统筹安排原则。 2．节约使用、讲求经济效益原则。 第3 条职责分工。 1．公司财务部负责研发费用的审批和报销，并随时监督费用的使用情况。 2．软件研发部负责研发费用的预算与使用控制。 第2 章研发费用的来源及使用范围 第4 条研发费用的来源。 1．公司对重点研发产品的专项拨款。 2．公司成本列支的研发费用。 3．从其他方面筹措来用于研发的费用。 第5 条研发费用的使用范围。 1．研发活动直接消耗的材料、燃料和动力费用。 2．研发人员的工资、奖金、社会保险费、住房公积金等人工费用以及外聘研发人员的劳务费用。 3．用于研发活动的仪器、设备、房屋等固定资产的折旧费或租赁费以及相关固定资产的运行维护、维修等费用。 4．用于研发活动的软件、专利权、非专利技术等无形资产的摊销费用。 5．用于中间试验和产品试制的模具、工艺装备开发及制造费，设备调整及检验费，样品、样机及一般测试手段的购置费，试制产品的检验费等。 用。用。6．研发成果的论证、评审、验收、评估以及知识产权的申请费、注册费、代理费等费7．通过外包、合作研发等方式，委托其他单位、个人或与之合作进行研发而支付的费8．与研发活动直接相关的其他费用，包括技术图书资料费、资料翻译费、会议费、差 旅费、办公费、外事费、研发人员培训费、专家咨询费、高新科技研发保险费用等。 第3章研发费用的使用管理 第6 条专款专用。
软件工程文档模板范例.doc
目录 三、需求规格说明书 (2) 四、概要设计说明书 (12) 五、详细设计说明书 (15)
3软件需求说明书 软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下： 3.1引言 3.1.1编写的目的 3.1.2背景 3.1.3定义 3.1.1参考资料 3.2任务概述 3.2.1目标 3.2.2用户的点 3.2.3假定与约束 3.3需求规定 3.3.1对功能的规定 3.3.2对性能的规定
3.3.2.1精度 3.3.2.2时间特性要求 3.3.2.3灵活性 3.3.3输入输出要求 3.3.4数据管理能力的要求 3.3.5故障处理要求 3.3.6其它的专门的要求 3.4运行环境规定 3.4.1设备 3.4.2支持软件 3.4.3接口 3.4.4控制 4数据需求说明书 数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下： 4.1引言
4.1.1编写目的 4.1.2背景 4.1.3定义 4.1.4参考资料 4.2数据的逻辑描述 4.2.1静态数据 4.2.2动态输入数据 4.2.3动态输出数据 4.2.4内部生成数据 4.2.5数据约定 4.3数据的采集 4.3.1要求和范围 4.3.2输入的承担者 4.3.3处理 4.3.4影响 5概要设计说明书 概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目
的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下： 5.1引言 5.1.1编写目的 5.1.2背景 5.1.3定义 5.1.4参考资料 5.2总体设计 5.2.1需求规定 5.2.2运行环境 5.2.3基本设计概念和处理流程 5.2.4结构 5.2.5功能需求与程序的关系 5.2.6人工处理过程
软件开发与维护管理规范
软件开发与维护管理规范 1 目的通过规范软件的开发与维护过程，达到提高软件质量，降低维护成本的目的。 2 范围适用于新产品的软件开发设计以及定型产品的改进升级。 3 职责与权限 研发中心负责： a)编制软件开发过程的实施、协调和控制工作； b)编制各阶段的技术文件； c)组织软件的测试、验收、升级和维护工作。 各部门参与软件开发过程中有关的设计评审。 4 内容 软件项目的开发实施过程管理要求 软件项目实施过程总体要求 本部分主要要求工程师制定软件开发工作计划，对过程进行控制，一般包括以下的内容。a) 工程师提交软件开发工作大纲，项目组织者对工作大纲进行评审，并提出整改意见。 b)通过评审后，工程师根据整改意见完善工作大纲，经过项目经理认可后组织项目组进行 软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，工程师需分阶段提交相关文档。 c)在软件开发工作完成后，工程师应向项目组提交完整的软件文档，相关人员组织验收组对软件进行验收审查。 软件项目实施变更要求在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须提交《软件变更申请》经过项目组书面同意方可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变更记录，以使变更处于可控制的状态。 软件项目实施里程碑控制本部分主要对软件开发过程中的重要节点进行控制。项目组将分四个阶段进行把关，召开审查会。 a）需求分析（结合原型进行审查）确认；
b）概要设计+数据库设计； c）预验收（样机测试时）； d）正式验收（产品定型后）。 软件开发 软件开发必须严格按照软件工程的要求进行。开发过程包括工程师的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。 软件的需求分析 需求分析 需求分析要求开发人员准确理解用户的需求，进行细致的调查分析，将用户非形式的需求陈述转化为完整的需求定义，再由需求定义转化到相应的形式功能规约《软件需求规格说明书》的过程。 在《软件需求规格说明书》必须描述的基本问题是：功能、性能、强加于实现的设计限制、属性、外部接口。 需求报告评审在软件需求分析工作完成后，软件工程师应向项目组提交《软件需求规格说明书》。项目组组织有关人员（系统客户和系统开发人员等）对需求进行评审，以决定软件需求是否完善和恰当。项目组严格验证这些需求的正确性，一般从一致性，完整性，现实性，有效性四个方面进行验证。评审完成后，就可以进入软件的设计阶段。 软件的概要设计 概要设计 概要设计也称为系统设计，需要确定软件的总体结构，应该由哪些模块组成，以及模块与模块之间的接口关系，软件系统主要的数据结构和出错处理设计等，同时还要制定测试方案，形成概要设计说明书，为软件的详细设计提供基础。在概要设计时一般从以下几方面来考虑，遵循以下的流程。 概要设计和需求分析、详细设计之间的关系和区别需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述采用何种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微观上和框架内的设计，是编码的依据。概要设计是指导详细设计的依据。 概要设计的评审 在软件概要设计工作完成后，软件工程师应向项目组提交《软件概要设计》。评审通过后，即可进入详细设
国家标准软件开发主要编写规范
国家标准(GB 8567－88)软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 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. 控制精度或生产能力的提高。
软件开发文档模板
1引言 编写目的 背景 定义 参考资料 2总体设计 需求规定 运行环境 基本设计概念和处理流程 结构 功能器求与程序的关系 人工处理过程 尚未问决的问题 3接口设计 用户接口 外部接口 内部接口 4运行设计 运行模块组合 运行控制 运行时间 5系统数据结构设计 逻辑结构设计要点 物理结构设计要点 数据结构与程序的关系 6系统出错处理设计
出错信息 补救措施 系统维护设计 **************************************** 2、 ISO9001标准文档模版 第1章引言 编写目的 术语 参考文献 第2章系统概述 系统说明 系统任务 2.2.1 系统目标 2.2.2 运行环境 2.2.3 与其它系统关系 需求规定 2.3.1 功能需求 2.3.2 性能需求 2.3.3 数据要求 2.3.4 其它 第3章总体设计 系统物理结构 3.1.1 系统流程图 3.1.2 设备清单 软件结构图
3.2.1 模块结构图 3.2.2 模块清单 第4章模块功能描述 模块1（标识符）功能 模块2 （标识符）功能 第5章接口设计 用户界面 硬件接口 软件接口 通信接口 第6章数据结构设计 数据结构1 （标识符） 6.1.1 结构属性 6.1.2 逻辑结构 6.1.3 物理结构 6.1.4 数据元素 数据结构2 （标识符） 第7章运行设计 运行1 7.1.1 运行模块组合运行名称 7.1.2 运行控制操作 7.1.3 运行时间 运行2 第8章系统安全 系统安全 数据安全 后备与恢复
出错处理 计算机病毒的防治措施 第9章功能需求、数据结构和模块 功能需求与模块关系 数据结构与模块关系 **************************************** 概要设计说明书 1 引言 写目的：阐明编写概要设计说明书的目的，指明读者对象。 项目背景：应包括 ●项目的委托单位、开发单位和主管部门 ●该软件系统与其他系统的关系。 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 参考资料： ●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 ●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册 ●文档所引用的资料、采用的标准或规范。 2 任务概述 目标 需求概述 条件与限制 3 总体设计 总体结构和模块外部设计
软件开发技术文档编写规范
软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。
软件工程国家标准、行业标准一览
软件工程国家标准、行业标准一览摘自计算机软件工程规范国家标准汇编2003DZ/T 0169-1997 物探化探计算机软件开发规范 GB 17917-1999 商场管理信息系统基本功能要 求 GB 8566-1988 计算机软件开发规范(已为GB/T8566-1995替代) GB/T 11457-1995 软 件工程术语 GB/T 12504-1990 计算机软件质量保证计划规范 GB/T 12505-1990 计算机软 件配置管理计划规范 GB/T 14079-1993 软件维护指南 GB/T 14085-1993 信息处理系统计 算机系统配置图符号及约定 GB/T 15532-1995 计算机软件单元测试 GB/T 15538-1995 软 件工程标准分类法 GB/T 15853-1995 软件支持环境 GB/T 16260-1996 信息技术软件产品 评价质量特性及其使用指南 GB/T 16680-1996 软件文档管理指南 GB/T 17544-1998 信息技术软件包质量要求和测试 GB/T 17917-1999 商场管理信息系统基本功能要求 GB/T 18234-2000 信息技术C ASE工具地评价与选择指南 GB/T 18491.1-2001 信息技术软件 测量功能规模测量第1部分：概念定义 GB/T 18492-2001 信息技术系统及软件完整性级 别 GB/T 18905.1-2002 软件工程产品评价第1部分: 概述 GB/T 18905.2-2002 软件工程 产品评价第2部分: 策划和管理 GB/T 18905.3-2002 软件工程产品评价第3部分: 开发者用地过程 GB/T 18905.4-2002 软件工程产品评价第4部分: 需方用地过程 GB/T 18905.5-2002 软件工程产品评价第5部分: 评价者用地过程 GB/T 18905.6-2002 软件工 程产品评价第6部分: 评价模块地文档编制★GB/T 8566-1995 信息技术软件生存期过程(已为GB/T8566-2001替代) GB/T 8566-2001 信息技术软件生存周期过程 GB/T 9385-1988 计算机软件需求说明编制指南 GB/T 9386-1988 计算机软件测试文件编制规 范 GB/Z 18493-2001 信息技术软件生存周期过程指南 GB/Z 18914-2002 信息技术软件工 程CASE工具地采用指南 GJB 1091-1991 军用软件需求分析 GJB 1419-1992 军用计算 机软件摘要 GJB 2115-1994 军用软件工程管理规程 GJB 2255-1994 军用软件产品 GJB 3181-1998 军用软件支持环境选用要求 GJB 437-1988 军用软件开发规范 GJB 438-1988 军用软件文档编制规范 GJB 438A-1997 武器系统软件开发文档 GJB 439-1988 军用软件 质量保证规范 GJB/Z 102-1997 软件可靠性和安全性设计准则 GJB/Z 115-1998 GJB 2786《武器系统软件开发》剪裁指南 GJB/Z 117-1999 军用软件验证和确认计划指南 GJB/Z 68-1994 武器装备柔性制造系统软件工程手册 HB 6464-1990 软件开发规范 HB 6465-1990 软件文档编制规范 HB 6466-1990 软件质量保证计划编制规定 HB 6467-1990 软件配置管理计划编制规定 HB 6468-1990 软件需求分析阶段基本要求 HB 6469-1990 软件需求规格说明编制规定 HB 6698-1993 软件工具评价与选择地分类特性体系 HB/Z 177-1990 软件工程管理基本要求 HB/Z 178-1990 软件验收基本要求 HB/Z 179-1990 软 件维护基本要求 HB/Z 180-1990 软件质量特性与评价方法 HB/Z 182-1990 状态机软件开 发方法 JB/T 6987-1993 制造资源计划MRPⅡ系统原型法软件开发规范 SB/T 10264-1996 餐饮业计算机管理软件开发设计基本规范 SB/T 10265-1996 饭店业计算机管理软件开发设计基本规范 SJ 20681-1998 地空导弹指挥自动化系统软件模块通用规范 SJ 20778-2000 软件开发与文档编制 SJ/T 10367-1993 计算机过程控制软件开发规程 SJ/T 11234-2001 软件过程能力评估模型 SJ/T 11235-2001 软件能力成熟度模型 版权申明 本文部分内容，包括文字、图片、以及设计等在网上搜集整理。版权为潘宏亮个人所有 This article includes some parts, including text, pictures,