1、计算机软件需求说明编制指引计算机软件需求说明编制指南1 引言 1.1 目的和作用 本指南为软件需求实践提供了一个规范化的方法。本指南不提倡把软件需求说明(Software Requirements Specifications,以下简称SRS)划分成等级,避免把它定义成更小的需求子集。 本指南适用对象: 软件客户(Customers),以便精确地描述他们想获得什么样的产品。 软件开发者(Suppliers),以便准确地理解客户需要什么样的产品。 对于任一要实现下列目标的单位和(或)个人: a. 要提出开发规范化的SRS提纲; b. 定义自己需要的具体的格式和内容; c. 产生附加的局部使用条款
2、,如SRS质量检查清单或者SRS作者手册等。 SRS将完成下列目标: a. 在软件产品完成目标方面为客户和开发者之间建立共同协议创立一个基础。对要实现的软件功能做全面描述,帮助客户判断所规定的软件是否符合他们的要求,或者怎样修改这种软件才能适合他们的要求; b. 提高开发效率。编制SRS的过程将使客户在设计开始之前周密地思考全部需求,从而减少事后重新设计、重新编码和重新测试的返工活动。在SRS中对各种需求仔细地进行复查,还可以在开发早期发现若干遗漏、错误的理解和不一致性,以便及时加以纠正; c. 为成本计价和编制计划进度提供基础。SRS提供的对被开发软件产品的描述,是计算机软件产品成本核算的基
3、础,并且可以为各方的要价和付费提供依据。SRS对软件的清晰描述,有助于估计所必须的资源,并用作编制进度的依据; d. 为确认和验证提供一个基准。任何组织将更有效地编制他们的确认和验证计划。作为开发合同的一部分,SRS还可以提供一个可以度量和遵循的基准(然而,反之则不成立,即任一有关软件的合同都不能作为SRS。因为这种文件几乎不包括详尽的需求说明,并且通常不完全的); e. 便于移植。有了SRS就便于移值软件产品,以适应新的用户或新的机种。客户也易于移植其软件到其他部门,而开发者同样也易于把软件移植到新的客户; f.作为不断提高的基础。由于SRS所讨论的是软件产品,而不是开发这个产品的设计。因此
4、SRS是软件产品继续提高的基础。虽然SRS也可能要改变,但是原来的SRS还是软件产品改进的可靠基础。 1.2 范围 本指南适用于编写软件需求规格说明,它描述了一个SRS所必须的内容和质量,并且在第6章中提供了SRS大纲。 2 引用标准 GB 8566 计算机软件开发规范 GB 8567 计算机软件产品开发文件编制指南 GB/T 11457 软件工程术语 3 定义 GB/T 11457所列术语和下列定义适用于本指南。 合同(contract) 是由客户和开发者共同签署的具有法律约束力的文件。其中包括产品的技术、组织、成本和进度计划要求等内容。 客户(customer) 指个人或单位,他们为产品开
5、发提供资金,通常(但有时也不必)还提出各种需求。文件中的客户和开发者也可能是同一个组织的成员。 语言(language) 是具有语法和语义的通信工具,包括一组表达式、惯例和传递信息的有关规则。 分割(partitioning) 把一个整体分成若干部分。 开发者(supplier) 指为客户生产某种软件产品的个人或集团。在本指南中,客户和开发者可能是同一个组织的成员。 用户(user) 指运行系统或者直接与系统发生交互作用的个人或集团。用户和客户通常不是同一些人。 4 编写SRS的背景信息 4.1 SRS的基本要求 SRS是对要完成一定功能、性能的软件产品、程序或一组程序的说明。 对SRS的描述
6、有两项基本要求: a. 必须描述一定的功能、性能; b. 必须用确定的方法叙述这些功能、性能。 4.2 SRS的环境 必须认识到SRS在整个软件开发规范(见GB 8566)所规定的有关阶段都起作用。正因为如此,SRS的起草者必须特别注意不要超出这种作用的范围。这意味着要满足下列要求: a. SRS必须正确地定义所有的软件需求; b. 除了设计上的特殊限制之外,SRS中一般不描述任何设计、验证或项目管理细节。 4.3 SRS的特点 4.3.1 无歧义性 当且仅当它对每一个需求只有一种解释时,SRS者是无歧义的。 a. 要求最终产品的每一个特性用某一术语描述; b. 若某一术语在某一特殊的行文中使
7、用时具有多种歧义,那么对该术语的每种含义作出解释并指出其适用场合。 需求通常是用自然语言编写的,使用自然语言的SRS起草者必须特别注意消除其需求的歧义性。提倡使用形式化需求说明语言。 4.3.2 完整性 如果一个SRS能满足下列要求,则该SRS就是完整的: a. 包括全部有意义的要求,无论是关系到功能的、性能的、设计约束的,还是关系到属性或外部接口方面的需求; b. 对所有可能出现的输入数据的响应予以定义,要对合法和非合法的输入值的响应做出规定; c. 要符合SRS要求。如果个别章节不适用,则在SRS中要保留章节号; d. 填写SRS中的全部插图、表、图示标记和参照,并且定义全部术语和度量单位
8、。 4.3.2.1 关于使用“待定”一词的规定 任何一个使用“待定”的SRS都是不完全的。 a. 若万一遇到使用“待定”一词时,作如下处理: (1) 对产生“待定”一词的条件进行描述,使得问题能被解决; (2) 描述必须干什么事,以删除这个“待定”; b. 包含有“待定”一词的任何SRS的项目文件应该: (1) 标识与此特定文件有关的版本号或叙述其专门的发布号; (2) 拒绝任何仍标识为“待定”一词的SRS章节的许诺。 4.3.3 可验证性 当且仅当SRS中描述的每一个需求都是可以验证的,该SRS才是可以验证的;当且仅当在某一性能价格比可取的有限处理过程,人或机器能通过该过程检查软件产品能否满
9、足需求时,才称这个需求是可以验证的。 4.3.4 一致性 当且仅当SRS中各个需求的描述是不矛盾时SRS才是一致的。 4.3.5 可修改性 如果一个SRS的结构和风格在需求有必要改变时是易于实现的、完整性的、一致的,那么这个SRS就是可以修改的。可修改性要求SRS具备以下条件: a. 具有一个有条不紊的易于使用的内容组织,具有目录表,索引和明确的交叉引用表; b. 没有冗余。即同一需求不能在SRS中出现多次。 (1)冗余本身不是错误,但是容易发生错误。冗余可增加SRS的可读性,但是在一个冗余文件被更新时容易出现问题。例如:假设一个明确的需求在两个地方详细列出,后来发现这个需求需要改变,若只修改
10、一个地方,于是SRS就变得不一致了。 (2)不管冗余是否必须,SRS一定要包含一个详细的交叉引用表,以便SRS具备可修改性。 4.3.6 可追踪性 如果每一个需求的源流是清晰的,在进一步产生和改变文件编制时,可以方便地引证每一个需求,则该SRS就是可追踪的。建议采用如下两种类型的追踪: a. 向后追踪(即向已开发过的前一阶段追踪)。根据先前文件或本文件前面的每一个需求进行追踪。 b. 向前追踪(即是向由SRS派生的所有文件追踪)。根据SRS中具有唯一的名字和参照号的每一个需求进行追踪。 当SRS中的一个需求表达另一个需求的一种指派或者是派生的,向前、向后的追踪都要提供。例如: (1)从总的用户
11、响应时间需求中分配给数据库操作响应时间; (2)识别带有一定功能和用户接口的需求的报告格式; (3)支持法律或行政上需要的某个软件产品(例如,计算税收)。在这种情况下,要指出软件所支持的确切的法律或行政文件。 当软件产品进入运行和维护阶段时,SRS的向前可追踪性显得特别重要。当编码和设计文件作修改时,重要的是要查清这些修改所影响的全部需求。 4.3.7 运行和维护阶段的可使用性 SRS必须满足运行和维护阶段的需要,包括软件最终替换。 a. 维护常常是由与原来开发无联系的人来进行的。局部的改变(修正)可以借助于好的代码注释来实现。对于较大范围的改变。设计和需求文件是必不可少的,这里隐含了两个作用
12、: (1)如4.3.5 条指出,SRS必须是可修改的; (2)SRS中必须包括一个记录,它记录那些应用于各个成分的所有具体条文。例如: 它们的危急性(如故障可能危及完全或导致大量财政方面和社会方面的损失); 它们仅与暂时的需要相关(如支持一种可立即恢复原状的显示); 它们的来源(如某功能是由已存在的软件产品的全部拷贝复制而成)。 b. 要求在SRS中清楚地写明功能的来源和目的,因为对功能的来源和引入该功能的目的不清楚的话,通常不可能很好地完成软件的维护。 4.4 SRS的编制者 软件开发的过程是由开发者和客户双方同意开发什么样的软件协议开始的。这种协议要使用SRS的形式,应该由双方联合起草。这
13、是因为: a. 客户通常对软件设计和开发过程了解较少,而不能写出可用的SRS; b. 开发者通常对于客户的问题和意图了解较少,从而不可能写出一个令人满意的系统需求。 4.5 SRS的改进 软件产品的开发过程中,在项目的开始阶段不可能详细说明某些细节,在开发过程中可能发现SRS的缺陷、缺点和错误之类的问题,所以可能要对SRS进行改进。 在SRS的改进中,应注意如下事项: 4.5.1 尽管可以预见校正版本的开发以后不可避免,而对需求还必须尽可能完全、清楚地描述。 4.5.2 一旦最初识别出项目的变化,应引入一个正式的改变规程来标识、控制、追踪和报告项目的改变。批准了的需求改变,用如下的方法编入SR
14、S之中: a. 提供各种改变后的正确的、完全的审查记录; b. 允许对SRS当前的和被替代部分的审查。 4.6 SRS的编制工具 编制SRS最显而易见的方法是用自然语言来描述。尽管自然语言是丰富多彩的,但不易精确,用形式化的方法较好。 4.6.1 形式化说明方法 在SRS中是否使用形式化方法要依据下列因素: a. 程序规模和复杂性; b. 客户合同中是否要求使用; c. SRS是否是一个合同工具或仅仅是一个内部文件; d. SRS文件是否成为设计文件的根据; e. 具有支持这种方法的计算机设备。 4.6.2 生产工具 软件产品生产中有多种生产工具。比如,计算机的字处理器就是非常有用的生产辅助工
15、具。一个SRS通常有若干作者。可能经历若干版本,并且要进行多次重新组织内容。故生产工具是必要的。 4.6.3 表达工具 在SRS中有许多词汇,特别是许多名词和动词,专门涉及到系统的实体和许多活动,所以表达SRS需要若干工具。比如: a. 可以验证实体或活动,无论在SRS中什么地方都是同一名字。; b. 可以标识一个特殊的实体或动作在规格说明中的描述位置。 此外,可以使用若干种形式化方法,以便允许自动处理SRS内容,只要作某些限制就可以做到; 用一些表格或图示法来显示需求。 用详细分层体系自动检查SRS的需求,这里每一个分层自身是完全的,但是也可以扩展为下一层,或是上一层的一个组成成分。 自动检
16、查SRS具有在4.3条描述的部分或全部特点。5 软件需求 SRS中每一个软件需求是要求开发软件产品的某些基本功能和性能的一个陈述。 5.1 表达软件需求的方法 软件需求可以用若干种方法来表达: a. 通过输入、输出说明; b. 使用代表性的例子; c. 用规范化的模型。 5.1.1 输入、输出说明 用输入输出序列来描述一个软件产品所要求的特性是很有效的。 5.1.1.1 途径 根据被描述的软件的性质,至少有三种不同的途径: a. 有些软件产品(如报表系统)要求着重说明输出。一般情况下,致力于输出的系统主要是在数据文卷上操作。用户的输入通常是致力于提供控制信息和启动数据文卷的处理; b. 有些软
17、件产品需要着重说明输入、输出特性。关注输入、输出的系统主要是在当前的输入上操作,要求生成与输入相匹配的输出(类似于数据转换例行程序或一个数学函数包); c. 还有一些系统(如过程控制系统)要求记忆它们的状态。可以根据本次输入和上一次输入进行应答。也就是说,它的行为如同一个有限状态机。在此种情况下,既要关注输入/输出对,又要关注这些输入/输出对的次序。 5.1.1.2 困难 多数软件产品可能接收无限的序列作为输入,于是,为了通过输入输出序列完整地说明产品的特性,就要求SRS包括一个无限长的输入和所需的输出充列。然而,用这样的途径不可能完整地描述软件所要求的一切特性。 5.1.2 典型例子 一种选
18、择是用典型例子来说明要求的特性。例如,假设一个系统中当接收“0”时用“1”来回答。显然,要列出全部输入和输出序列是不可能的。然而,用典型的序列可以十分清楚地理解系统的特性。下面是一组四种对话的典型的例子,用它描述系统特性。 0101 010101010101 01 010101 这些对话仅提供了要求的输入和输出之间的关系,但是不能完全描述系统的特性。 5.1.3 模型 另一种表达需求的方法是模型的方式,这是表达复杂需求的精确和有效方法。 至少可以提出三种可供使用的通用模型:数学型、功能型、计时型。 应注意区别各种模型的应用场合,参考5.1.3.5。 5.1.3.1 数学模型 数学模型是使用数学
19、关系描述软件特性的模型。数学模型对某些特殊应用领域是特别有用的。例如,导航、线性规划、计量经济、信号处理和气象分析等。 用数学模型能够对5.1.2中所讨论的典型例子描述如下: (01)*。 这里,“*”号表示括号内的字符串可以重复一次或多次。 5.1.3.2 功能模型 功能模型是提供从略语以输出映象的模型。象有限状态机或Petri网,这些功能模型可以有助于标识和定义软件的各种特点,或者可以表示系统所要进行的操作。 对前面用数学模型描述的例子。可用图1所示的有限状态机形式的功能模型来描述。图中进入的箭头表示启动状态。双线的方框表示接收状态。在各线记号x/y的含义是:x代表接受的输入,而y是产生的
20、输出。 5.1.3.3 计时模型 计时模型是一种增加了时间限制的模型。这种模型对于表达软件特性的形式和细节特别有用。尤其是实时系统或考虑人为因素的系统。 计时模型可以把下列限制加到图1的模型中去: a. 激活因素0将在进入S1状态30S之内出现; b. 响应1将在进入S2状态2S之内出现。 5.1.3.4 其他模型 队了上面提及的模型外。对一些特殊的应用还有一些特别有用的模型。例如,编译程序的说明可以使用属性文法,工资单系统可以使用表格。要注意的是,对SRS使用形式需求语言,通常含有使用特殊模型的意思。 5.1.3.5 警告 无论使用哪一类型的模型,都要: 在SRS中或在SRS涉及到的一个文件
21、中对它严格定义。这个定义应该规定: a. 模型中的参数所要求的范围; b. 使用时的限定值; c. 结果的精确度; d. 负载的能力; e. 要求的执行时间; f. 缺省或失败时的响应。 必须注意,在需求的定义域内要保持一个模型定义。每当一个SRS使用一个模型时: a. 它意味着此模型提供一个十分有效和精确的方法说明需求; b. 并不意味着软件产品的实现必须基于这个模型。 一个模型用于解释文件所写的需求是有效的,但是对于实际软件的实现可能并不是最适宜的。 5.2 软件需求的注释 有关软件产品的所有需求,并不是同等重要的。某些需求可能是基本的,例如是对于生命攸关的应用。而另一些可能并不那么重要。
22、 SRS中每一个需求必须进行注释,以便区别其重要的程度。 有这种方法注释需求,可以: a. 帮助客户对每一个需求给予更周密的考虑,通常可以在需求中澄清隐藏的假设; b. 帮助开发者做出正确的设计决定,并对软件产品不同部分作出相应的努力。 5.2.1 稳定性 注释需求的一种方法是使用稳定性量纲。当一个需求在软件预期的生存期间内描述不改变的话,可以认为该需求是稳定的,否则可以认为是易变的。 5.2.2 必要性等级 注释的另一种方法是把需求分成必须保证级、期望级和任选级。 a. 必须保证是指软件必须和这些需求相一致,否则该软件不可能被接受; b. 期望是指这些需求将提高软件产品的功能,但是如果缺省的
23、话也是可接受的; c. 任选是给开发者一个机会,可以提供某些超出SRS规定的目标。 5.2.3 注意事项 在注释需求之前,必须彻底理解这种注释的实质性含义。 5.3 在表达需求时遇到的共同弊病 SRS的基本点是它必须说明由软件获得的结果,而不是获得这些结果的手段。 编写需求的人必须描述的基本问题是: a. 功能所设计的软件要做什么; b. 性能是指软件功能在执行过程中的速度、可使用性、响应时间、各种软件功能的恢复时间、吞吐能力、精度、频率等等; c. 强加于实现的设计限制在效果、实现的语言、数据库完整性、资源限制、操作环境等等方面所要求的标准; d. 属性可移植性、正确性、可维护性及安全性等方
24、面的考虑因素; e. 外部接口与人、硬件、其他软件和其他硬件的相互关系。 编写需求的人应当避免把设计或项目需求写入SRS之中,应当对说明需求设计约束与规划设计两者有清晰的区别。 5.3.1 在SRS中嵌入了设计 在SRS中嵌入设计说明,会过多地约束软件设计,并且人为地把具有潜在危险的需求放入SRS中。 5.3.1.1 SRS必须描述在干什么数据上、为谁完成什么功能、在什么地方、产生什么结果。SRS应把注意力集中在要完成的服务目标上。通常不指定如下的设计项目: a. 把软件划分成若干模块; b. 给每一个模块分配功能; c. 描述模块间的信息流程或者控制流程; d. 选择数据结构。 5.3.1.
25、2 把设计完全同SRS隔离开来始终是不现实的。安全和保密方面的周密考虑可能增加一些直接反映设计约束的需求。例如: a. 在一些分散的模块中保持某些功能; b. 允许在程序的某些区域之间进行有限的通讯; c. 计算临界值的检查和。 5.3.1.3 通常应考虑到,若要为软件选择高层次的设计,就可能需要大量的资源(可能占整个产品开发成本的10%-20%以上)。有两种选择: a. 不顾本指南的警告,在SRS中描述了设计。这意味着,或者将一个潜在不适当的设计作为一个需求进行描述(因为,若要得到好的设计,所花费的时间是不够的),或者在需求阶段花费了过多的时间(因为在SRS完成之前整个设计分析都要完成);
26、b. 采用本指南中5.1.3条中的建议,用模型设计描述需求,这种模型设计只用于辅助描述需求,而不使之成为实际的设计。 5.3.2 在SRS中嵌入了一些项目要求 SRS应当是描写一个软件产品,而不是描述生产软件产品的过程。 项目要求表达客户和开发者之间对于软件生产方面合同性事宜的理解(因此不应当包括在SRS中)例如: a. 成本; b. 交货进度; c. 报表处理; d. 软件开发方法; e. 质量保证; f. 确认和验证的标准; g. 验收过程。 项目需求在另外的文件中描述。在SRS中提供的只是关于软件产品本身的需求。6 SRS大纲本章着重讨论SRS的每一个基本部分,可以作为一个SRS的大纲。
27、表1给出该大纲目录,表2至表5给出大纲中第3章的具体需求内容。各开发者和客户应当根据所描述的实际情况,按本指南有关规定编写自己的SRS。 1 前言 1.1 目的 1.2 范围 1.3 定义、缩写词、略语 1.4 参考资料 2 项目概述 2.1 产品描述 2.2 产品功能 2.3 用户特点 2.4 一般约束 2.5 假设和依据 3 具体需求 (参阅本指南6.3.2 条中具体需求的组织形式) 附录 索引 6.1 前言(SRS第1章) 本章提供整个SRS综述。 6.1.1 目的(SRS的1.1条) 在这一条包括下列内容: a. 描述实际SRS的目的; b. 说明SRS所预期的读者。 6.1.2 范围
28、(SRS的1.2条) a. 用一个名字标识被生产的软件产品。比如:数据库系统,报表生成程序等等; b. 说明软件产品将干什么,如果需要的话,还要说明软件产品不干什么; c. 描述所说明的软件的应用。应当: (1)尽可能精确地描述所有相关的利闪、目的、以及最终目标。 (2)如果有一个较高层次的说明存在,则应该使其和高层次说明中的类似的陈述相一致(例如,系统的需求规格说明)。 6.1.3 定义、缩写词、略语(SRS的1.3条) 本条中必须提供全部需求的术语、缩写词及略语的定义,以便对SRS进行适当的解释。这些信息可以由SRS的附录提供。也可以参考其他的文件。 6.1.4 参考资料(SRS的1.4条
29、) 本条应包括: a. 在SRS中各处参照的文件的全部清单,如经核准的计划任务书,上级机关批文、合同等; b. 列出其他参考资料,如属本项目的其他已发表的文件和主要文献等。每一个文件、文献要有标题,索引号或文件号,发布或发表日期以及出版单位; c. 详细说明可以得到该参考文件的来源。这个信息可以通过引用附录或其他文件提供。 6.2 项目概述(SRS第2章) 本章应描述影响产品和其需求的一般因素,本章不说明具体的需求,而仅使需求更易于理解。 6.2.1 产品描述(SRS的2.1条) 这一条是把一个产品用其他有关的产品或项目来描述。 a. 如果这个产品是独立的,而且全部内容自含,应在此说明; b.
30、 如果SRS定义的产品是一个较大的系统或项目中的一个组成部分,那么本条应包括如下内容: (1)要概述这个较大的系统或项目的每一个组成部分的功能,并说明其接口; (2)指出该软件产品主要的外部接口。在这里,不要求对接口详细地描述,详细描述放在SRS其他章条中; (3)描述所使用的计算机硬件、外围设备。这里仅仅是一个综述性描述。 在本条的描述中,用一个方框图来表达一个较大的系统或项目的主要组成部分、相互联系和外部接口是非常有帮助的。 本条既不用来强迫进行设计方案的描述,也不是描述在解决问题时的设计约束。本条应对在以后具体需求一章中说明的设计约束提供理由。 6.2.2 产品功能(SRS的2.2条)
31、本条是为将要完成的软件功能提供一个摘要。例如,对于一个记帐程序来说,SRS可以用这部分来描述:客户帐目维护、客户财务报表和发票制作,而不必把功能所要求的大量的细节描写出来。 有时,如果存在较高层次的规格说明时,则功能摘要可直接从中取得,这个较高层次的规格说明为软件产品分配了特殊的功能,为了清晰起见,请注意: a. 编制功能的一种方法是制作功能表,以便客户或者第一次读这个文件的人都可以理解; b. 用方框图来表达不同的功能和它们的关系也是有帮助的。但要牢记,这样的图不是产品设计时所需求的,而只是一种有效的解释性的工具。 这一条不用作陈述具体需求,只是对后来SRS中具体需求一章中为什么要描述的某些需求提供理由。 6.2.3 用户特点(SRS的2.3条) 本条要描述影响具体需求的产品的最终用户的一般特点。 许多人在软件生存周期的操作和维护阶段与系统相关。而这些人中有用户、操作员、维护人员和系统工作人员。这些人的某
copyright@ 2008-2022 冰豆网网站版权所有
经营许可证编号:鄂ICP备2022015515号-1