计算机软件文档编制规范,最新

'计算机软件文档编制规范,最新　　篇一：《计算机软件文档编制规范》GB-T8567-XX　　ICSL77　　中华人民共和国国家标准　　GB/T8567-XX代替GB/T8567-1988　　计算机软件文档编制规范　　Specificationforcomputersoftwaredocumentation　　XX-03-14发布XX-07-01实施　　中华人民共和国国家质量监督检验检疫总局　　发布　　中国国家标准化管理委员会　　目次　　前言　　1范围　　2规范性引用文件3术语和定义4缩略语5文档过程5．1概述　　5．2源材料准备5．3文档计划5．4文档开发5．5评审　　5．6与其他公司的文档开发子合同6文档编制要求　　6．1软件生存周期与各种文档的编制6．2文档编制中的考虑因素7文档编制格式 　　7．1可行性分析(研究)报告(FAR)7．2软件开发计划(SDP)7．3软件测试计划(STP)7．4软件安装计划(SIP)　　7．5软件移交计划(STrP)7．6运行概念说明(OCD)　　7．7系统/子系统需求规格说明(SSS)7．8接口需求规格说明(IRS)　　7．9系统/子系统设计(结构设计)说明(SSDD)7．10接口设计说明(IDD)　　7．11软件需求规格说明(SRS)　　7．12数据需求说明(DRD)　　7．13软件(结构)设计说明(SDD)7．14数据库(顶层)设计说明(DBDD)7．15软件测试说明(STD)7．16软件测试报告(STR)　　7．17软件配置管理计划(SCMP)7．18软件质量保证计划(SQAP)7．19开发进度月报(DPMR)7．20项目开发总结报告(PDSR)7．21软件产品规格说明(SPS)7．22软件版本说明(SVD)7．23软件用户手册(SUM)7．24计算机操作手册(COM)　　7．25计算机编程手册(CPM)　　附录A(规范性附录)面向对象软件的文档编制A．1综述　　A．2总体说明文档A．3用况图文档A．4类图文档A．5顺序图文档A．6协作图文档A．7状态图文档 A．8活动图文档A．9构件图文档A．10部署图文档A．11包图文档参考文献　　前言　　本标准是GB/T8567—1988《计算机软件产品开发文件编制指南》的修订版，并改名为《计算机软件文档编制规范》。本标准从实施之日起代替GB/T8567—1988。　　本标准与GB/T8567—1988相比，主要变化如下：　　a)本标准增加了文档编写过程。其内容参考了ISO/IECJTCl/SC7N21061999/04/15《软件工程——用　　户文档过程》。　　b)本标准主要从软件开发与管理的角度，规定相应的文档及规范。其内容依据GB/T8566—XX《软　　件生存周期过程》。　　c)在编写本标准时，综合了在软件开发与管理中的经验及中软网络技术股份有限公司有关CMM　　中拟订的一些文档规范。　　d)本标准与SJ20—XX《软件开发与文档编制》很好地链接。　　e)本标准在规定软件需求规格说明、软件测试文件、软件质量保证计划与软件配置管理计划等文档　　时，既依据相应的国标，又根据发展与实践经验作了相应的扩展。 　　f)本标准把SJ/T11291—XX《面向对象的软件系统建模规范第3部分：文档编制》中的文档编制　　规范作为本标准的规范性附录。本标准的附录A是规范性附录。　　本标准由中华人民共和国信息产业部提出。　　本标准由信息产业部电子工业标准化研究所归口。　　本标准起草单位：中软网络技术股份有限公司、信息产业部电子工业标准化研究所、北京联想软件有限公司、用友软件股份有限公司。　　本标准主要起草人；周明德、冯惠、韩乃平、欧阳春生、殷树勋、黄万镒、强学锋、韩振江、邓适宜。　　计算机软件文档编制规范　　1范围　　本标准根据GB/T8566—XX《信息技术软件生存周期过程》的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。　　本标准原则上适用于所有类型的软件产品的开发过程和管理过程。 　　使用者可根据实际情况对本标准进行适当剪裁(可剪裁所需的文档类型，也可对规范的内容作适当裁剪)。软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档(开发文档)两类。供方应提供的文档的类型和规模，由软件的需方和供方在合同中规定。　　2规范性引用文件　　下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。　　GB/T8566—XX信息技术软件生存周期过程(idtISO/IEC：12207：1995)　　GB/T11457—XX软件工程术语　　3术语和定义　　GB/T11457—XX确立的以及下列术语和定义适用于本标准。验收acceptance　　需方授权代表的一项活动，通过该活动，需方接受履行合同的部分或全部的软件产品的所有权。需方acqui　　为自己或为另一个组织采购软件产品的组织。　　批准approval　　需方的授权代表或开发方的上级组织对开发方的项目计划、设计或其他方面表示满意并可以作为下一阶段工作基础而签署的书面文件。　　体系结构architecture 　　一个系统或CSCI(ComputerSoftwareConfigurationItem-计算机软件配置项)的组织结构，标明它的组成，这些组成的接口和它们之间的操作概念。　　相关开发方associatedeveloper　　一个既不是主承包方也不是开发方的分承包方的组织，但它在同一个或相关系统或项目中承担开发工作。行为设计behavioraldesign　　从用户观点出发，对整个系统或CScI的行为进行的设计，它只考虑满足用户需求而不考虑系统或CSCI的内部实现。这种设计与体系结构设计不同，后者要标明系统或CSCI的内部部件，并有这些部件的详细设计。　　构建版；开发阶段build　　(1)软件的一个版本，它满足完整的软件所要满足的全部需求的一个特定的子集。(2)开发满足特定需求子集的软件版本所经历的时间。　　注：术语一开发阶段”和一版本”之间的关系依赖于开发方：例如，可以通过几个版本来实现一个开发阶段，一个开发阶段也可以发行几个并行的版本(如发往不同的地点)，或者将它们用作为同义词。　　计算机数据库computerdatabase见数据库。　　计算机硬件c(来自:小龙文档网:计算机软件文档编制规范,最新)omputerhardware 　　能接收和存储计算机数据的，对计算机数据执行一系列系统性的操作的，或能产生控制输出的设备。这类设备能实现基本的解释、计算、通信、控制或其他逻辑功能。　　计算机程序computerprogram　　能使计算机硬件实现计算或控制功能的计算机指令和数据定义的集合。　　计算机软件computersoftware　　见软件。　　计算机软件配置项computersoftwareconfigurationitem(CSCI)　　满足最终使用功能的软件集合，而且它由需方指定进行单独的配置管理。CSCI应从下列诸因素中进行折衷选择：软件功能、规模、宿主机或目标计算机、开发方、支持概念、重用计划、关键性、接口考虑、是否需要单独编写文档和控制以及其他因素。　　配置项configurationitem能满足最终使用功能的硬件集合、软件集合或者软、硬件两者的集合，且由需方指定进行单独的配置管理。数据库database以一种能被用户或计算机程序通过一个数据库管理系统进行访问的方式，存储在一个或多个计算机文件中的相关数据的集合。　　数据库管理系统databasemanagementsystem 　　是一整套计算机程序，它提供为建立、修改、使用和完整性维护一个数据库所需的功能。可交付的软件产品deliverablesoftwareproduct合同要求交付给需方或其他指定的接受方的软件产品。设计design　　开发方为响应一定的需求而对一个系统或CSCI选取的一些性能/规格。这些特性中有些是与需GB/T8567-XX求相匹配的：有一些是需求的精细化，如为了响应显示错误信息这一需求而定义所有的错误信息；有一些则是与实现有关的，如为满足需求，决定选用哪些软件配置项和逻辑。　　开发方developer　　开发软件产品的组织(“开发”包括新的软件开发、修改、重用、再工程、维护或产生软件产品的任何其他活动)。开发方可以是一个承制方或者政府机构。　　文档/文档编制document/documentation　　能供人或机器阅读的，一般具有永久性的一套资料(不管它们记录在什么媒体上)。评价evaluation　　确定一个项或一个活动是否满足指定准则的过程。固件firmware　　硬件设备和以只读软件的形式驻留在硬件设备上的计算机指令和/或计算机数据的组合。硬件配置项hardwareconfigurationitem(HWCI)满足最终使用功能并由需方指定进行单独配置管理的一套硬件。　　独立验证与确认independentverificationand validation(IV＆V)　　由一个机构对软件产品和活动作系统的评估，这个机构不负责该产品的开发或被评估的活动。IV＆V不在本标准的范围内。　　接口interface在软件开发中，两个或多个实体(如cscI—cscIcscI—HWC：ICSCI一用户，或软件配置项一软件配置项)之间的关系。这些实体依据这种关系共享、提供或交换数据。接口并不是CSCI、软件配置项或其他的系统部件；接口只是这些实体间的一种关系。　　联合评审jointreview　　由需方和开发方双方代表参加的对项目状态、软件产品和/或项目中的问题进行检查和讨论的活动或会议。非交付的软件产品Non-deliverablesoftwaerproduct不是合同中要求交付给需方或其他指定接受方的软件产品。　　过程process　　为实现某个既定目的而进行的一组有组织的活动，例如，软件开发过程。合格性测试qualificationtesting　　为了向需方表明一个CSCI或系统满足其指定的需求而进行的测试。　　再工程reengineering　　为了以一种新的形式重组一个现有的系统而对其进行检查和改造的过程。再工程可包括逆向工程(分析一 　　篇二：计算机软件文档编制规范　　《计算机软件文档编写指南》　　一．计算机软件文档由封面、目录、正文、注释和附录组成。封面格式：　　密级：编号：　　文档名称：　　项目名称：　　编制：　　审核：　　批准：　　×××××××××××××研究所　　年月日　　二．计算机软件文档包括：　　1）软件开发计划　　2）软件需求规格说明　　3）接口需求规格说明　　4）接口设计文档　　5）软件设计文档　　6）软件产品规格说明　　7）版本说明文档　　8）软件测试计划　　9）软件测试说明 　　10）软件测试报告　　11）计算机系统操作员手册　　12）软件用户手册　　13）软件程序员手册　　14）计算机资源综合保障文件　　软件开发计划　　一．引言　　1．编写目的（阐明编写软件计划的目的，指出读者对象。）　　2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）　　3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）　　4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）　　二．项目概述　　1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等.若不编写可行性研究报告,则应在本节给出较详细的介绍。)　　2.条件与限制（阐明为完成项目应具备的条件 开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）　　3.产品　　（1）程序（列出应交付的程序名称使用的语言及存储形式。）　　（2）文档（列出应交付的文档。）　　（3）运行环境（应包括硬件环境软件环境。）　　4．服务（阐明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。）　　5．验收标准　　三．实施计划　　1．任务分解（任务的划分及各项任务的负责人。）　　2．进度（按阶段完成的项目,用图表说明开始时间完成时间。）　　3．预算　　4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）　　四．人员组织及分工　　五．交付期限　　六．专题计划要点（如测试计划质量保证计划配置管理计划人员培训计划系统安装计划等。）　　软件需求规格说明 　　一．引言　　1．编写目的（阐明编写需求说明书的目的,指明读者对象。）　　2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他　　系统的关系。）　　3．定义（列出文档中用到的专门术语定义和缩写词的原文。）　　4．参考资料（可包括：（1）项目经核准的计划任务书,合同或上机机关的批文；（2）项目开　　发计划；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）　　二．任务概述　　1．目标　　2．运行环境　　3．条件与限制　　三．数据描述　　1．静态数据　　2．动态数据（包括输入数据和输出数据。）　　3．数据库描述（给出使用数据库的名称和类型。）　　4．数据词典 　　5．数据采集　　四．功能需求　　1．功能划分　　2．功能描述　　五．性能需求　　1．数据精确度　　2．时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）　　3．适应性（在操作方式运行环境与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）　　六．运行需求　　1．用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）　　2．硬件接口　　3．软件接口　　4．故障处理　　七．　　其他需求（如可使用性、安全保密、可维护性、可移植性等。）　　概要设计说明书　　一．引言　　1． 编写目的（阐明编写概要设计说明书的目的，指明读者对象。）　　2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）　　3．定义（列出文档中用到的专门术语定义和缩写词的原意。）　　4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目经核准的计划任务书，合同或上机机关的批文；（2）项目开发计划；（3）需求规格说明书；（4）测试计划（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）　　二．任务概述　　1．目标　　2．运行环境　　3．需求概述　　4．条件与限制　　三．总体设计　　1．处理流程　　2．总体结构和模块外部设计　　3．功能分配（表明各项功能与程序结构的关系。）　　四．接口设计　　1．外部接口（包括用户界面软件接口与硬件接口。） 　　2．内部接口（模块之间的接口。）　　五．数据结构设计　　1．逻辑结构设计　　2．物理结构设计　　3．数据结构与程序的关系　　六．运行设计　　1．运行模块的组合　　2．运行控制　　3．运行时间　　七．出错处理设计　　1．出错输出信息　　2．出错处理对策（如设置后备、性能降级、恢复及再启动等。）　　八．　　安全保密设计九．维护设计（说明为方便维护工作的设施,如维护模块等。）　　详细设计说明书　　一．引言　　1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）　　2．项目背景（应包括项目的来源和主管部门等。） 　　3．定义（列出文档中用到的专门术语定义和缩写词的原意。）　　4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：　　（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说明书；（3）概要设计说明书；（4）测试计划(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软件开发标准或规范。）　　二．总体设计　　1．需求概述　　2．软件结构（如给出软件系统的结果图。）　　三．程序描述（逐个模块给出以下的说明:：）　　1．功能　　2．性能　　3．输入项目　　4．输出项目　　5．算法（模块所选用的算法。）　　6．程序逻辑（详细描述模块实现的算法，可采用:：（1）标准流程图；（2）PDL语言；（3）N-S图；（4）PAD；（5）判定表等描述算法的图表。）　　7．接口　　8．存储分配　　9．限制条件 　　篇三：01计算机软件测试文件编制规范01　　1目的　　本规范规定一组软件测试文件。测试是软件生存周期中一个独立的﹑关键的阶段，也是保证软件质量的重要手段。为了提高检测出错误的几率，使软件能有计划地﹑有条不紊地进行，就必须要编制测试软件。而标准化的测试文件就如同一种通用的参照体系，可达到便于交流的目的。文件中所规定的内容可以作为对测试过程的每个阶段的能见度，极大的提高测试工作的可管理性。　　2适用范围　　本规范是为软件管理人员﹑软件开发人员、软件维护人员﹑软件质量保证人员﹑审核人员及顾客（用户）制定的。本规范用于描述一组测试文件，这些测试文件描述测试行为。本规范定义每一种基本文件的目的﹑格式和内容。所描述的文件着重于动态测试过程，但仍有些文件适用于其他种类的测试活动。　　本规范可应用于数字计算机上运行的软件。它的应用范围不受软件大小、复杂度或重要性的限制，本规范既适用于初始开发的软件测试文件编制，也适用于其后的软件产品更新版本的测试文件编制。 　　本规范既适用于纸张上的文件，也适用于其它媒体上的文件。如果电子文件编制系统不具有安全的批准注册机制，则批准签字的文件必须使用纸张。　　3引用文件　　GB/T11457-1995《软件工程术语》　　GB/T8567-1988《计算机软件产品开发文件编制指南》　　GB/T19000-3-1994《在软件开发、供应和维护中的使用指南》　　4术语　　设计层　　软件项的设计分解（如系统、子系统、程序或模块）。　　通过准则　　判断一个软件享货软件的测试是否通过的判别依据。　　软件特性　　软件项的显著特性（如功能、性能或可移植性等）。　　软件项　　原代码、目标代码、作业控制代码、控制数据或这些项的集合。　　5职责　　项目经理负责对软件测试文件编写的组织领导工作。　　软件产品策化负责具体软件测试文件的编写工作。　　软件部配置管理员负责本部门软件测试文件的具体归档及管理工作并在项目结束后将文件传到质量管理部门归档工作. 　　6工作程序　　主要内容　　本规范规定了各个测试文件的格式和内容，所提出的文件类型包括测试计划、测试说明和测试报告。　　测试计划描述测试活动的范围、方法、资源和进度。它规定被测试的项、被测试的特性、应完成的测试任务、担任各项工作的人员职责及本计划有关的风险等。　　测试类型包括：功能测试、边界测试、性能测试、可行性测试。　　测试说明包括三类文件：　　（1）测试设计说明：详细描述测试方法，规定该设计及其有关测试所包括的特性，还规定完成测试所需的测试用例和测试规程，并规定特性的通过准则。　　（2）测试用例说明：列出用于输入的具体值以及预期的输出结果，并规定在使用具体测试用例时，对测试规程的各种限制。将测试用例与测试设计分开，可以使它们用于多个设计并能在其它情形下重复使用。　　（3）测试规程说明：规定对于运行系统和执行指定的测试用例来实现有关测试设计所要求的所有步骤。　　测试报告包括四类文件： 　　（1）测试项传递报告：指明在开发组和测试组独立工作的情况下或者在希望正式开始测试的情况下为进行测试而被传递的测试项。　　（2）测试日志：测试组用于记录测试执行过程中发生的情况。　　（3）测试事件报告：描述在测试执行期间发生并需要进一步调查的一切事件。　　（4）测试总结报告：总结与测试设计说明有关的测试活动。　　这些文件同其它文件在编制方面的关系以及同测试过程的对应关系如图1所示。　　实施灵活性　　在本标准中，涉及软件测试的文件有“测试计划”及“测试分析报告”。本规范中的八个测试事件是上述二个测试文件的补充和细化，这样可使文件的书写更具体、更有参照性，其中测试计划可细化为本规范的测试计划、测试设计说明、测试用例、测试用例说明及测试规范说明，测试分析报告可细化为本规范的测试项传递报告、测试日志、测试事件报告及测试总结报告。　　在所提供的每个标准文件中，每一章的内容对于具体的应用和特定的测试阶段可以有所增减。不仅可以调整内容，还可以在基本文件集中增加另外的文件。任何一个文件都可以增加新内容，并且某章若无可写内容，则可以不写。但须保留该章的编号。 　　总体要求　　以下将叙述各个测试文件的书写格式及内容。对于每一个文件而言各章应按指定的次序排列，补充的章可以放在最后或放在“批准”一章的前面（如果该文件最后一章是“批准”　　的话）。如果某章的部分或全部内容在另一文件中，则应在相应的内容位置上列出所引用的文件，引用的文件必须附在该文件后面或交给该文件的使用者。　　当需要时，对测试活动与结果进行分析，并形成测试分析报告以便不断积累经验、改进软件的设计质量。　　7相关文件　　测试计划　　测试计划说明　　测试用例说明　　测试规程说明　　测试项传递报告　　测试日志　　测试事件报告　　测试总结报告　　测试分析报告（需要时）　　本规范未规定的处理　　图1.测试文件与测试过程的关系 　　'