当前位置:文档之家› 软件技术文档编写规范

软件技术文档编写规范

软件技术文档编写规范
软件技术文档编写规范

目录

第一章引言 1

§1.1 目的 1

§1.2 文档约定 1

§1.3 预期读者和阅读建议 1

§1.4 产品的范围 1

§1.5 参考文献 1

第二章综合描叙 1

§2.1 产品的前景 1

§2.2 产品的功能 1

§2.3 用户类和特征 2

§2.4 运行环境 2

§2.5 设计和实现上的限制 2

§2.6 假设和依赖 2

第三章外部接口需求 2

§3.1 用户界面 2

§3.2 硬件接口 3

§3.3 软件接口 3

§3.4 通信接口 3

第四章系统特性 3

§4.1 说明和优先级 3

§4.2 激励响应序列 3

§4.3 功能需求 3

第五章其他非功能需求 3

§5.1 性能需求 3

§5.2 安全设施需求 4

§5.3 安全性需求 4

§5.4 软件质量属性 4

§5.5 业务规则 4

§5.6 用户文档 4

第六章其他需求 4

§6.1 词汇表 4

§6.2 分析模型 4

§6.3 待确定问题列表 5

第1章引言

引言提出了对软件需求规格说明的纵览,这有助于读者理解文档如何编写并且如何阅读和解释。

§1.1 目的

对产品进行定义,在该文档中详尽说明了这个产品的软件需求,包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系,那么就只定义文档中说明的部分或子系统。

§1.2 文档约定

描述编写文档时所采用的标准或排版约定,包括正文风格、提示区或重要符号。例如,说明了高层需求的优先级是否可以被其所有细化的需求所继承,或者每个需求陈述是否都有其自身的优先级。

§1.3 预期读者和阅读建议

列举了软件需求规格说明所针对的不同读者,例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。

§1.4 产品的范围

提供了对指定的软件及其目的的简短描述,包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。

§1.5 参考文献

列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档,或相关产品的软件需求规格说明。在这里应该给出详细的信息,包括标题名称、作者、版本号、日期、出版单位或资料来源,以方便读者查阅这些文献。

如:

a.本项目的经核准的计划任务书或合同、上级机关的批文;

b.属于本项目的其他已发表的文件;

c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。

第2章综合描叙

这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。

§2.1 产品的前景

描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员,是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品,或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分,那么就要说明这部分软件是怎样与整个系统相关联的,并且要定义出两者之间的接口。

§2.2 产品的功能

概述了产品所具有的主要功能。其详细内容将在 d 中描述,所以在此只需要概略地总结,例如用列表的方法给出。很好地组织产品的功能,使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系,例如数据流程图的顶层图或类图,都是有用的。

§2.3 用户类和特征

确定你觉得可能使用该产品的不同用户类并描述它们相关的特征(见第7 章)。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。

§2.4 运行环境

描述了软件的运行环境,包括硬件平台、操作系统和版本,还有其它的软件组件或与其共存的应用程序。

§2.5 设计和实现上的限制

确定影响开发人员自由选择的问题,并说明这些问题为什么成为一种限制。可能的限制包括如下内容:

·必须使用或者避免的特定技术、工具、编程语言和数据库。

·所要求的开发规范或标准(例如,如果由客户的公司负责软件维护,就必须定义转包者所使用的设计符号表示和编码标准。

·企业策略、政府法规或工业标准。

·硬件限制,例如定时需求或存储器限制。

·数据转换格式标准。

§2.6 假设和依赖

确定影响开发人员自由选择的问题,并说明这些问题为什么成为一种限制。可能的限制包括如下内容:

·必须使用或者避免的特定技术、工具、编程语言和数据库。

·所要求的开发规范或标准(例如,如果由客户的公司负责软件维护,就必须定义转包者所使用的设计符号表示和编码标准。

·企业策略、政府法规或工业标准。

·硬件限制,例如定时需求或存储器限制。

·数据转换格式标准。

第3章外部接口需求

利用本节来确定可以保证新产品与外部组件正确连接的需求。关联图表示了高层抽象的外部接口。需要把对接口数据和控制组件的详细描述写入数据字典中。如果产品的不同部分有不同的外部接口,那么应把这些外部接口的详细需求并入到这一部分的实例中。

§3.1 用户界面

陈述所需要的用户界面的软件组件。描述每个用户界面的逻辑特征。以下是可能要包括的一些特征:

·将要采用的图形用户界面(G U I )标准或产品系列的风格。

·屏幕布局或解决方案的限制。

·将出现在每个屏幕的标准按钮、功能或导航链接(例如一个帮助按钮)。·快捷键。

·错误信息显示标准。

对于用户界面的细节,例如特定对话框的布局,应该写入一个独立的用户界面规格说明中,而不能写入软件需求规格说明中。

§3.2 硬件接口

描述系统中软件和硬件每一接口的特征。这种描述可能包括支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议。

§3.3 软件接口

描述该产品与其它外部组件(由名字和版本识别)的连接,包括数据库、操作系统、工具、库和集成的商业组件。明确并描述在软件组件之间交换数据或消息的目的。描述所需要的服务以及内部组件通信的性质。确定将在组件之间共享的数据。如果必须用一种特殊的方法来实现数据共享机制,例如在多任务操作系统中的一个全局数据区,那么就必须把它定义为一种实现上的限制。

§3.4 通信接口

描述与产品所使用的通信功能相关的需求,包括电子邮件、We b 浏览

器、网络通信标准或协议及电子表格等等。定义了相关的消息格式。规定通信安全或加密问题、数据传输速率和同步通信机制。

对我有用[0] 丢个板砖[0] 引用举报管理TOP

csdsq

(〓1〓0〓1〓0〓1〓0〓1〓)

等级:

#6楼得分:0回复于:2003-04-29 02:18:05第4章系统特性

功能需求是根据系统特性即产品所提供的主要服务来组织的。你可能更喜欢通过使用实例、运行模式、用户类、对象类或功能等级来组织这部分内容(I E E E 1 9 9 8 )。你还可以使用这些元素的组合。总而言之,你必须选择一种使读者易于理解预期产品的组织方案。仅用简短的语句说明特性的名称,例如“4 . 1 拼写检查和拼写字典管理”。无论你想说明何种特性,阐述每种特性时都将重述从4 . 1 ~4 . 3 这三步系统特性。

§4.1 说明和优先级

提出了对该系统特性的简短说明并指出该特性的优先级是高、中,还是低。或者你还可以包括对特定优先级部分的评价,例如利益、损失、费用和风险,其相对优先等级可以从1(低)到9 (高)。

§4.2 激励响应序列

列出输入激励(用户动作、来自外部设备的信号或其它触发器)和定义这一特性行为的系统响应序列。就像在第8 章讨论的那样,这些序列将与使用实例相关的对话元素相对应。

§4.3 功能需求

详列出与该特性相关的详细功能需求。这些是必须提交给用户的软件功能,使用户可以使用所提供的特性执行服务或者使用所指定的使用实例执行任务。描述产品如何响应可预知的出错条件或者非法输入或动作。就像本章开头所描述的那样,你必须唯一地标识每个需求。

第5章其他非功能需求

这部分列举出了所有非功能需求,而不是外部接口需求和限制。

§5.1 性能需求

阐述了不同的应用领域对产品性能的需求,并解释它们的原理以帮助开发人员作出合理的设计选择。确定相互合作的用户数或者所支持的操作、响应时间以及与实时系统的时间关系。你还可以在这里定义容量需求,例如存储器和磁盘空间的需求或者存储在数据库中表的最大行数。尽可能详细地确定性能需求。可能需要针对每个功能需求或特性分别陈述其性能需求,而不是把它们都集中在一起陈述。例如,“在运行微软Window 2000 的450 MHzPentiumⅡ的计算机上,当系统至少有5 0 %的空闲资源时,9 5 %的目录数据库查询必须在两秒内完成”。

§5.2 安全设施需求

详尽陈述与产品使用过程中可能发生的损失、破坏或危害相关的需求。定义必须采取的安全保护或动作,还有那些预防的潜在的危险动作。明确产品必须遵从的安全标准、策略或规则。一个安全设施需求的范例如下:“如果油箱的压力超过了规定的最大压力的9 5 %,那么必须在1 秒钟内终止操作”。

§5.3 安全性需求

详尽陈述与系统安全性、完整性或与私人问题相关的需求,这些问题将会影响到产品的使用和产品所创建或使用的数据的保护。定义用户身份确认或授权需求。明确产品必须满足的安全性或保密性策略。你可能更喜欢通过称为完整性的质量属性来阐述这些需求,完整性将在第11 章介绍。一个软件系统的安全需求的范例如下:“每个用户在第一次登录后,必须更改他的最初登录密码。最初的登录密码不能重用。”

§5.4 软件质量属性

详尽陈述与客户或开发人员至关重要的其它产品质量特性(见第11 章)。这些特性必须是确定、定量的并在可能时是可验证的。至少应指明不同属性的相对侧重点,例如易用程度优于易学程度,或者可移植性优于有效性。

§5.5 业务规则

列举出有关产品的所有操作规则,例如什么人在特定环境下可以进行何种操作。这些本身不是功能需求,但它们可以暗示某些功能需求执行这些规则。一个业务规则的范例如下:“只有持有管理员密码的用户才能执行$ 1 0 0 .

0 0 或更大额的退款操作。”

§5.6 用户文档

列举出将与软件一同发行的用户文档部分,例如,用户手册、在线帮助和教程。明确所有已知的用户文档的交付格式或标准。

第6章其他需求

定义在软件需求规格说明的其它部分未出现的需求,例如国际化需求或法律上的需求。你还可以增加有关操作、管理和维护部分来完善产品安装、配置、启动和关闭、修复和容错,以及登录和监控操作等方面的需求。在模板中加入与你的项目相关的新部分。如果你不需要增加其它需求,就省略这一部分。

§6.1 词汇表

定义所有必要的术语,以便读者可以正确地解释软件需求规格说明,包括词头和缩写。你可能希望为整个公司创建一张跨越多项项目的词汇表,并且只包括特定于单一项目的软件需求规格说明中的术语。

§6.2 分析模型

这个可选部分包括或涉及到相关的分析模型的位置,例如数据流程图、类图、状态转换图或实体-关系图

§6.3 待确定问题列表

编辑一张在软件需求规格说明中待确定问题的列表,其中每一表项都是编上号的,以便于跟踪调查。

计算机软件需求说明编制指南

1 引言

1.1 目的和作用

本指南为软件需求实践提供了一个规范化的方法。本指南不提倡把软件需求说明(Software Requirements Specifications,以下简称SRS)划分成等级,避免把它定义成更小的需求子集。

本指南适用对象:

软件客户(Customers),以便精确地描述他们想获得什么样的产品。

软件开发者(Suppliers),以便准确地理解客户需要什么样的产品。

对于任一要实现下列目标的单位和(或)个人:

a. 要提出开发规范化的SRS提纲;

b. 定义自己需要的具体的格式和内容;

c. 产生附加的局部使用条款,如SRS质量检查清单或者SRS作者手册等。SRS将完成下列目标:

a. 在软件产品完成目标方面为客户和开发者之间建立共同协议创立一个基础。对要实现的软件功能做全面描述,帮助客户判断所规定的软件是否符合他们的要求,或者怎样修改这种软件才能适合他们的要求;

b. 提高开发效率。编制SRS的过程将使客户在设计开始之前周密地思考全部需求,从而减少事后重新设计、重新编码和重新测试的返工活动。在SRS中对各种需求仔细地进行复查,还可以在开发早期发现若干遗漏、错误的理解和不一致性,以便及时加以纠正;

c. 为成本计价和编制计划进度提供基础。SRS提供的对被开发软件产品的描述,是计算机软件产品成本核算的基础,并且可以为各方的要价和付费提供依据。SRS对软件的清晰描述,有助于估计所必须的资源,并用作编制进度的依据;

d. 为确认和验证提供一个基准。任何组织将更有效地编制他们的确认和验证计划。作为开发合同的一部分,SRS还可以提供一个可以度量和遵循的基准(然而,反之则不成立,即任一有关软件的合同都不能作为SRS。因为这种文件几乎不包括详尽的需求说明,并且通常不完全的);

e. 便于移植。有了SRS就便于移值软件产品,以适应新的用户或新的机种。客户也易于移植其软件到其他部门,而开发者同样也易于把软件移植到新的客户;

f.作为不断提高的基础。由于SRS所讨论的是软件产品,而不是开发这个产品的设计。因此SRS是软件产品继续提高的基础。虽然SRS也可能要改变,但是原来的SRS还是软件产品改进的可靠基础。

1.2 范围

本指南适用于编写软件需求规格说明,它描述了一个SRS所必须的内容和质量,并且在第6章中提供了SRS大纲。

2 引用标准

GB 8566 计算机软件开发规范

GB 8567 计算机软件产品开发文件编制指南

GB/T 11457 软件工程术语

3 定义

GB/T 11457所列术语和下列定义适用于本指南。

合同(contract)

是由客户和开发者共同签署的具有法律约束力的文件。其中包括产品的技术、组织、成本和进度计划要求等内容。

客户(customer)

指个人或单位,他们为产品开发提供资金,通常(但有时也不必)还提出各种需求。文件中的客户和开发者也可能是同一个组织的成员。

语言(language)

是具有语法和语义的通信工具,包括一组表达式、惯例和传递信息的有关规则。分割(partitioning)

把一个整体分成若干部分。

开发者(supplier)

指为客户生产某种软件产品的个人或集团。在本指南中,客户和开发者可能是同一个组织的成员。

用户(user)

指运行系统或者直接与系统发生交互作用的个人或集团。用户和客户通常不是同一些人。

4 编写SRS的背景信息

4.1 SRS的基本要求

SRS是对要完成一定功能、性能的软件产品、程序或一组程序的说明。

对SRS的描述有两项基本要求:

a. 必须描述一定的功能、性能;

b. 必须用确定的方法叙述这些功能、性能。

4.2 SRS的环境

必须认识到SRS在整个软件开发规范(见GB 8566)所规定的有关阶段都起作用。正因为如此,SRS的起草者必须特别注意不要超出这种作用的范围。这意味着要满足下列要求:

a. SRS必须正确地定义所有的软件需求;

b. 除了设计上的特殊限制之外,SRS中一般不描述任何设计、验证或项目管理细节。

4.3 SRS的特点

4.3.1 无歧义性

当且仅当它对每一个需求只有一种解释时,SRS者是无歧义的。

a. 要求最终产品的每一个特性用某一术语描述;

b. 若某一术语在某一特殊的行文中使用时具有多种歧义,那么对该术语的每种含义作出解释并指出其适用场合。

需求通常是用自然语言编写的,使用自然语言的SRS起草者必须特别注意消除其需求的歧义性。提倡使用形式化需求说明语言。

4.3.2 完整性

如果一个SRS能满足下列要求,则该SRS就是完整的:

a. 包括全部有意义的要求,无论是关系到功能的、性能的、设计约束的,还是关系到属性或外部接口方面的需求;

b. 对所有可能出现的输入数据的响应予以定义,要对合法和非合法的输入值的响应做出规定;

c. 要符合SRS要求。如果个别章节不适用,则在SRS中要保留章节号;

d. 填写SRS中的全部插图、表、图示标记和参照,并且定义全部术语和度量

单位。

4.3.2.1 关于使用“待定”一词的规定

任何一个使用“待定”的SRS都是不完全的。

a. 若万一遇到使用“待定”一词时,作如下处理:

(1)对产生“待定”一词的条件进行描述,使得问题能被解决;

(2)描述必须干什么事,以删除这个“待定”;

b. 包含有“待定”一词的任何SRS的项目文件应该:

(1)标识与此特定文件有关的版本号或叙述其专门的发布号;

(2)拒绝任何仍标识为“待定”一词的SRS章节的许诺。

4.3.3 可验证性

当且仅当SRS中描述的每一个需求都是可以验证的,该SRS才是可以验证的;当且仅当在某一性能价格比可取的有限处理过程,人或机器能通过该过程检查软件产品能否满足需求时,才称这个需求是可以验证的。

4.3.4 一致性

当且仅当SRS中各个需求的描述是不矛盾时SRS才是一致的。

4.3.5 可修改性

如果一个SRS的结构和风格在需求有必要改变时是易于实现的、完整性的、一致的,那么这个SRS就是可以修改的。可修改性要求SRS具备以下条件:

a. 具有一个有条不紊的易于使用的内容组织,具有目录表,索引和明确的交叉引用表;

b. 没有冗余。即同一需求不能在SRS中出现多次。

(1)冗余本身不是错误,但是容易发生错误。冗余可增加SRS的可读性,但是在一个冗余文件被更新时容易出现问题。例如:假设一个明确的需求在两个地方详细列出,后来发现这个需求需要改变,若只修改一个地方,于是SRS就变得不一致了。

(2)不管冗余是否必须,SRS一定要包含一个详细的交叉引用表,以便SRS具备可修改性。

4.3.6 可追踪性

如果每一个需求的源流是清晰的,在进一步产生和改变文件编制时,可以方便地引证每一个需求,则该SRS就是可追踪的。建议采用如下两种类型的追踪:a. 向后追踪(即向已开发过的前一阶段追踪)。根据先前文件或本文件前面的每一个需求进行追踪。

b. 向前追踪(即是向由SRS派生的所有文件追踪)。根据SRS中具有唯一的名字和参照号的每一个需求进行追踪。

当SRS中的一个需求表达另一个需求的一种指派或者是派生的,向前、向后的追踪都要提供。例如:

(1)从总的用户响应时间需求中分配给数据库操作响应时间;

(2)识别带有一定功能和用户接口的需求的报告格式;

(3)支持法律或行政上需要的某个软件产品(例如,计算税收)。在这种情况下,要指出软件所支持的确切的法律或行政文件。

当软件产品进入运行和维护阶段时,SRS的向前可追踪性显得特别重要。当编码和设计文件作修改时,重要的是要查清这些修改所影响的全部需求。

4.3.7 运行和维护阶段的可使用性

SRS必须满足运行和维护阶段的需要,包括软件最终替换。

a. 维护常常是由与原来开发无联系的人来进行的。局部的改变(修正)可以借助于好的代码注释来实现。对于较大范围的改变。设计和需求文件是必不可少的,这里隐含了两个作用:

(1)如4.3.5 条指出,SRS必须是可修改的;

(2)SRS中必须包括一个记录,它记录那些应用于各个成分的所有具体条文。例如:

它们的危急性(如故障可能危及完全或导致大量财政方面和社会方面的损失);它们仅与暂时的需要相关(如支持一种可立即恢复原状的显示);

它们的来源(如某功能是由已存在的软件产品的全部拷贝复制而成)。

b. 要求在SRS中清楚地写明功能的来源和目的,因为对功能的来源和引入该功能的目的不清楚的话,通常不可能很好地完成软件的维护。

4.4 SRS的编制者

软件开发的过程是由开发者和客户双方同意开发什么样的软件协议开始的。这种协议要使用SRS的形式,应该由双方联合起草。这是因为:

a. 客户通常对软件设计和开发过程了解较少,而不能写出可用的SRS;

b. 开发者通常对于客户的问题和意图了解较少,从而不可能写出一个令人满意的系统需求。

4.5 SRS的改进

软件产品的开发过程中,在项目的开始阶段不可能详细说明某些细节,在开发过程中可能发现SRS的缺陷、缺点和错误之类的问题,所以可能要对SRS进行改进。

在SRS的改进中,应注意如下事项:

4.5.1 尽管可以预见校正版本的开发以后不可避免,而对需求还必须尽可能完全、清楚地描述。

4.5.2 一旦最初识别出项目的变化,应引入一个正式的改变规程来标识、控制、追踪和报告项目的改变。批准了的需求改变,用如下的方法编入SRS之中:

a. 提供各种改变后的正确的、完全的审查记录;

b. 允许对SRS当前的和被替代部分的审查。

SRS的编制工具

编制SRS最显而易见的方法是用自然语言来描述。尽管自然语言是丰富多彩的,但不易精确,用形式化的方法较好。

4.6.1 形式化说明方法

在SRS中是否使用形式化方法要依据下列因素:

a. 程序规模和复杂性;

b. 客户合同中是否要求使用;

c. SRS是否是一个合同工具或仅仅是一个内部文件;

d. SRS文件是否成为设计文件的根据;

e. 具有支持这种方法的计算机设备。

4.6.2 生产工具

软件产品生产中有多种生产工具。比如,计算机的字处理器就是非常有用的生产辅助工具。一个SRS通常有若干作者。可能经历若干版本,并且要进行多次重新组织内容。故生产工具是必要的。

4.6.3 表达工具

在SRS中有许多词汇,特别是许多名词和动词,专门涉及到系统的实体和许多活动,所以表达SRS需要若干工具。比如:

a. 可以验证实体或活动,无论在SRS中什么地方都是同一名字。;

b. 可以标识一个特殊的实体或动作在规格说明中的描述位置。

此外,可以使用若干种形式化方法,以便允许自动处理SRS内容,只要作某些限制就可以做到;

用一些表格或图示法来显示需求。

用详细分层体系自动检查SRS的需求,这里每一个分层自身是完全的,但是也可以扩展为下一层,或是上一层的一个组成成分。

自动检查SRS具有在4.3条描述的部分或全部特点。

5 软件需求

SRS中每一个软件需求是要求开发软件产品的某些基本功能和性能的一个陈述。

5.1 表达软件需求的方法

软件需求可以用若干种方法来表达:

a. 通过输入、输出说明;

b. 使用代表性的例子;

c. 用规范化的模型。

5.1.1 输入、输出说明

用输入输出序列来描述一个软件产品所要求的特性是很有效的。

5.1.1.1 途径

根据被描述的软件的性质,至少有三种不同的途径:

a. 有些软件产品(如报表系统)要求着重说明输出。一般情况下,致力于输出的系统主要是在数据文卷上操作。用户的输入通常是致力于提供控制信息和启动数据文卷的处理;

b. 有些软件产品需要着重说明输入、输出特性。关注输入、输出的系统主要是在当前的输入上操作,要求生成与输入相匹配的输出(类似于数据转换例行程序或一个数学函数包);

c. 还有一些系统(如过程控制系统)要求记忆它们的状态。可以根据本次输入和上一次输入进行应答。也就是说,它的行为如同一个有限状态机。在此种情况下,既要关注输入/输出对,又要关注这些输入/输出对的次序。

5.1.1.2 困难

多数软件产品可能接收无限的序列作为输入,于是,为了通过输入输出序列完整地说明产品的特性,就要求SRS包括一个无限长的输入和所需的输出充列。然而,用这样的途径不可能完整地描述软件所要求的一切特性。

5.1.2 典型例子

一种选择是用典型例子来说明要求的特性。例如,假设一个系统中当接收“0”时用“1”来回答。显然,要列出全部输入和输出序列是不可能的。然而,用典型的序列可以十分清楚地理解系统的特性。下面是一组四种对话的典型的例子,用它描述系统特性。

0101

010*********

01

010101

这些对话仅提供了要求的输入和输出之间的关系,但是不能完全描述系统的特性。

5.1.3 模型

另一种表达需求的方法是模型的方式,这是表达复杂需求的精确和有效方法。至少可以提出三种可供使用的通用模型:数学型、功能型、计时型。

应注意区别各种模型的应用场合,参考5.1.3.5。

5.1.3.1 数学模型

数学模型是使用数学关系描述软件特性的模型。数学模型对某些特殊应用领域是特别有用的。例如,导航、线性规划、计量经济、信号处理和气象分析等。

用数学模型能够对5.1.2中所讨论的典型例子描述如下:

(01)*。

这里,“*”号表示括号内的字符串可以重复一次或多次。

5.1.3.2 功能模型

功能模型是提供从略语以输出映象的模型。象有限状态机或Petri网,这些功能模型可以有助于标识和定义软件的各种特点,或者可以表示系统所要进行的操作。

对前面用数学模型描述的例子。可用图1所示的有限状态机形式的功能模型来描述。图中进入的箭头表示启动状态。双线的方框表示接收状态。在各线记号x/y 的含义是:x代表接受的输入,而y是产生的输出。

5.1.3.3 计时模型

计时模型是一种增加了时间限制的模型。这种模型对于表达软件特性的形式和细节特别有用。尤其是实时系统或考虑人为因素的系统。

计时模型可以把下列限制加到图1的模型中去:

a. 激活因素0将在进入S1状态30S之内出现;

b. 响应1将在进入S2状态2S之内出现。

5.1.3.4 其他模型

队了上面提及的模型外。对一些特殊的应用还有一些特别有用的模型。例如,编译程序的说明可以使用属性文法,工资单系统可以使用表格。要注意的是,对SRS使用形式需求语言,通常含有使用特殊模型的意思。

5.1.3.5 警告

无论使用哪一类型的模型,都要:

在SRS中或在SRS涉及到的一个文件中对它严格定义。这个定义应该规定:

a. 模型中的参数所要求的范围;

b. 使用时的限定值;

c. 结果的精确度;

d. 负载的能力;

e. 要求的执行时间;

f. 缺省或失败时的响应。

必须注意,在需求的定义域内要保持一个模型定义。每当一个SRS使用一个模型时:

a. 它意味着此模型提供一个十分有效和精确的方法说明需求;

b. 并不意味着软件产品的实现必须基于这个模型。

一个模型用于解释文件所写的需求是有效的,但是对于实际软件的实现可能并不是最适宜的。

5.2 软件需求的注释

有关软件产品的所有需求,并不是同等重要的。某些需求可能是基本的,例如是对于生命攸关的应用。而另一些可能并不那么重要。

SRS中每一个需求必须进行注释,以便区别其重要的程度。

有这种方法注释需求,可以:

a. 帮助客户对每一个需求给予更周密的考虑,通常可以在需求中澄清隐藏的假设;

b. 帮助开发者做出正确的设计决定,并对软件产品不同部分作出相应的努力。

5.2.1 稳定性

注释需求的一种方法是使用稳定性量纲。当一个需求在软件预期的生存期间内描述不改变的话,可以认为该需求是稳定的,否则可以认为是易变的。

5.2.2 必要性等级

注释的另一种方法是把需求分成必须保证级、期望级和任选级。

a. 必须保证是指软件必须和这些需求相一致,否则该软件不可能被接受;

b. 期望是指这些需求将提高软件产品的功能,但是如果缺省的话也是可接受的;

c. 任选是给开发者一个机会,可以提供某些超出SRS规定的目标。

5.2.3 注意事项

在注释需求之前,必须彻底理解这种注释的实质性含义。

5.3 在表达需求时遇到的共同弊病

SRS的基本点是它必须说明由软件获得的结果,而不是获得这些结果的手段。编写需求的人必须描述的基本问题是:

a. 功能——所设计的软件要做什么;

b. 性能——是指软件功能在执行过程中的速度、可使用性、响应时间、各种软件功能的恢复时间、吞吐能力、精度、频率等等;

c. 强加于实现的设计限制——在效果、实现的语言、数据库完整性、资源限制、操作环境等等方面所要求的标准;

d. 属性——可移植性、正确性、可维护性及安全性等方面的考虑因素;

e. 外部接口——与人、硬件、其他软件和其他硬件的相互关系。

编写需求的人应当避免把设计或项目需求写入SRS之中,应当对说明需求设计约束与规划设计两者有清晰的区别。

5.3.1 在SRS中嵌入了设计

在SRS中嵌入设计说明,会过多地约束软件设计,并且人为地把具有潜在危险的需求放入SRS中。

5.3.1.1 SRS必须描述在干什么数据上、为谁完成什么功能、在什么地方、产生什么结果。SRS应把注意力集中在要完成的服务目标上。通常不指定如下的设计项目:

a. 把软件划分成若干模块;

b. 给每一个模块分配功能;

c. 描述模块间的信息流程或者控制流程;

d. 选择数据结构。

5.3.1.2 把设计完全同SRS隔离开来始终是不现实的。安全和保密方面的周密考虑可能增加一些直接反映设计约束的需求。例如:

a. 在一些分散的模块中保持某些功能;

b. 允许在程序的某些区域之间进行有限的通讯;

c. 计算临界值的检查和。

5.3.1.3 通常应考虑到,若要为软件选择高层次的设计,就可能需要大量的资源(可能占整个产品开发成本的10%-20%以上)。有两种选择:

a. 不顾本指南的警告,在SRS中描述了设计。这意味着,或者将一个潜在不适当的设计作为一个需求进行描述(因为,若要得到好的设计,所花费的时间是不够的),或者在需求阶段花费了过多的时间(因为在SRS完成之前整个设计分析都要完成);

b. 采用本指南中5.1.3条中的建议,用模型设计描述需求,这种模型设计只用于辅助描述需求,而不使之成为实际的设计。

5.3.2 在SRS中嵌入了一些项目要求

SRS应当是描写一个软件产品,而不是描述生产软件产品的过程。

项目要求表达客户和开发者之间对于软件生产方面合同性事宜的理解(因此不应当包括在SRS中)例如:

a. 成本;

b. 交货进度;

c. 报表处理;

d. 软件开发方法;

e. 质量保证;

f. 确认和验证的标准;

g. 验收过程。

项目需求在另外的文件中描述。在SRS中提供的只是关于软件产品本身的需求。

6 SRS大纲

本章着重讨论SRS的每一个基本部分,可以作为一个SRS的大纲。表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 范围(SRS的1.2条)

a. 用一个名字标识被生产的软件产品。比如:×××数据库系统,报表生成程序等等;

b. 说明软件产品将干什么,如果需要的话,还要说明软件产品不干什么;

c. 描述所说明的软件的应用。应当:

(1)尽可能精确地描述所有相关的利闪、目的、以及最终目标。

(2)如果有一个较高层次的说明存在,则应该使其和高层次说明中的类似的陈述相一致(例如,系统的需求规格说明)。

6.1.3 定义、缩写词、略语(SRS的1.3条)

本条中必须提供全部需求的术语、缩写词及略语的定义,以便对SRS进行适当的解释。这些信息可以由SRS的附录提供。也可以参考其他的文件。

6.1.4 参考资料(SRS的1.4条)

本条应包括:

a. 在SRS中各处参照的文件的全部清单,如经核准的计划任务书,上级机关批文、合同等;

b. 列出其他参考资料,如属本项目的其他已发表的文件和主要文献等。每一个文件、文献要有标题,索引号或文件号,发布或发表日期以及出版单位;

c. 详细说明可以得到该参考文件的来源。这个信息可以通过引用附录或其他文件提供。

6.2 项目概述(SRS第2章)

本章应描述影响产品和其需求的一般因素,本章不说明具体的需求,而仅使需求更易于理解。

6.2.1 产品描述(SRS的2.1条)

这一条是把一个产品用其他有关的产品或项目来描述。

a. 如果这个产品是独立的,而且全部内容自含,应在此说明;

b. 如果SRS定义的产品是一个较大的系统或项目中的一个组成部分,那么本条应包括如下内容:

(1)要概述这个较大的系统或项目的每一个组成部分的功能,并说明其接口;(2)指出该软件产品主要的外部接口。在这里,不要求对接口详细地描述,详细描述放在SRS其他章条中;

(3)描述所使用的计算机硬件、外围设备。这里仅仅是一个综述性描述。

在本条的描述中,用一个方框图来表达一个较大的系统或项目的主要组成部分、相互联系和外部接口是非常有帮助的。

本条既不用来强迫进行设计方案的描述,也不是描述在解决问题时的设计约束。本条应对在以后具体需求一章中说明的设计约束提供理由。

6.2.2 产品功能(SRS的2.2条)

本条是为将要完成的软件功能提供一个摘要。例如,对于一个记帐程序来说,SRS 可以用这部分来描述:客户帐目维护、客户财务报表和发票制作,而不必把功能所要求的大量的细节描写出来。

有时,如果存在较高层次的规格说明时,则功能摘要可直接从中取得,这个较高层次的规格说明为软件产品分配了特殊的功能,为了清晰起见,请注意:

a. 编制功能的一种方法是制作功能表,以便客户或者第一次读这个文件的人都可以理解;

b. 用方框图来表达不同的功能和它们的关系也是有帮助的。但要牢记,这样的图不是产品设计时所需求的,而只是一种有效的解释性的工具。

这一条不用作陈述具体需求,只是对后来SRS中具体需求一章中为什么要描述的某些需求提供理由。

6.2.3 用户特点(SRS的2.3条)

本条要描述影响具体需求的产品的最终用户的一般特点。

许多人在软件生存周期的操作和维护阶段与系统相关。而这些人中有用户、操作员、维护人员和系统工作人员。这些人的某些特点,象教育水平、经验、技术、专长等,都是施加于系统操作环境的重要约束。

如果系统的大多数用户是一些临时用户,那么就要求系统包含如何完成基本功能的提示,而不是假设用户已经从过去的会议或从阅读用户指南中了解到这些细节。

这一条的内容不能用来陈述具体需求或强加若干特殊的设计约束,本条应对在SRS的具体需求一章之中的某些具体需求或设计约束的描述提供理由。

6.2.4 一般约束(SRS的2.4条)

本条对设计系统阳限制开发者选择的其他一些项作一般性描述。而这些项将限定开发者在设计系统时的任选项。这些包括:

a. 管理方针;

b. 硬件的限制;

c. 与其他应用间的接口;

d. 并行操作;

e. 审查功能;

f. 控制功能;

g. 所需的高级语言;

h. 通信协议;

i. 应用的临界点;

j. 安全和保密方面的考虑。

本条不陈述具体需求或具体设计约束:而对SRS的具体需求一章中为什么要确定某些具体需求和设计约束提供理由。

6.2.5 假设和依据(SRS的2.5条)

本条列出影响SRS中陈述的需求的每一个因素。这些因素不是软件的设计约束,但是它们的改变可能影响到SRS中的需求。例如:假定一个特定的操作系统是在被软件产品指定的硬件上使用的,然而,事实上这个操作系统是不可能使用的,于是,SRS就要进行相应的改变。

6.3 具体需求(SRS的第3章)

本章应包括软件开发者在建立设计时需要的全部细节。这是SRS中篇幅最大和最重要的部分。

a. 根据本指南第4章所规定的准则(如可验证性、无歧义性等),对每一个需求细节作具体描述;

b. 在SRS的前言、项目概述、附录部分的有关讨论中,要提供对任何一个具体需求交叉引用的背景;

c. 具体需求分类的方法如下:

(1)功能需求;

(2)性能需求;

(3)设计约束;

(4)属性;

(5)外部接口需求。

本章中要注意的二点是:

a. 按符合逻辑的和可读的方式组织;

b. 详细描述每一个需求,使得该需求应达到目标能够用指定的方法进行客观的验证。

6.3.1 具体需求的内容

6.3.1.1 功能需求

本条描述软件产品的输入怎样变换成输出。即软件必须完成的基本动作。

对于每一类功能或者有时对于每一个功能,需要具体描述其输入、加工和输出的需求。这通常由四个部颁组成:

a. 引言

这部分描述的是功能要达到的目标、所采用的方法和技术,还应清楚说明功能意图的由来和背景。

b. 输入

这部分应包括:

(1)详细描述该功能的所有输入数据,如:

输入源、数量、度量单位、时间设定、有效输入范围(包括精度和公差);(2)操作员控制细节的需求。其中有名字、操作员活动的描述、控制台或操作员的位置。例如:当打印检查时,要求操作员进行格式调整;

(3)指明引用接口说明或接口控制文件的参考资料。

c. 加工

定义输入数据、中间参数,以获得预期输出结果的全部操作。它包括如下的说明:(1)输入数据的有效性检查;

(2)操作的顺序,包括事件的时间设定;

(3)异常情况的响应,例如,溢出、通信故障、错误处理等;

(4)受操作影响的参数;

(5)降级运行的要求;

(6)用于把系统输入变换成相应输出的任何方法(方程式、数学算法、逻辑操作等);

(7)输出数据的有效性检查。

d. 输出

这部分应包括:

(1)详细描述该功能所有输出数据,例如:输出目的地、数量、度量单位、时间关系、有效输出的范围(包括精度和公差)、非法值的处理、出错信息;(2)有关接口说明或接口控制文件的参考资料。

此外,对着重于输入输出行为的系统来说,SRS应指定所有有意义的输入、输出对及其序列。当一个系统要求记忆它的状态时,需要这个序列,使得它可以根据本次输入和以前的状态作出响应。也就是说,这种情况犹如有限状态机。

6.3.1.3 设计约束

设计约束受其他标准、硬件限制等方面的影响。

6.3.1.3.1 其他标准的约束

本项将指定由现有的标准或规则派生的要求。例如:

a. 报表格式;

b. 数据命名;

c. 财务处理;

d. 审计追踪,等等。

6.3.1.3.2 硬件的限制

本项包括在各种硬件约束下运行的软件要求,例如,应该包括:

a. 硬件配置的特点(接口数,指令系统等);

b. 内存储器和辅助存储器的容量。

6.3.1.4 属性

在软件的需求之中有若干个属性,下面指出其中的几个(注意:对这些决不应理解为是一个完整的清单)。

6.3.1.4.1 可用性

可以指定一些因素,如检查点、恢复和再启动等,以保证整个系统有一个确定的可用性级别。

6.3.1.4.2 安全性

这里指的是保护软件的要素,以防止各种非法的访问、使用,修改、破坏或者泄密。这个领域的具体需求必须包括:

a. 利用可靠的密码技术;

b. 掌握特定的记录或历史数据集;

c. 给不同的模块分配不同的功能;

d. 限定一个程序中某些区域的通信;

e. 计算临界值的检查和。

6.3.1.4.3 可维护性

这里规定若干需求以确保软件是可维护的。例如:

a. 软件模块所需要的特殊的耦合矩阵;

b. 对微型装置指定特殊的数据/程序分割要求。

对我有用[0] 丢个板砖[0] 引用举报管理TOP

microhell

(microhell)

等级:

#14楼得分:0回复于:2003-04-29 02:55:206.3.1.4.4 可转移/转换性

这里规定把软件从一种环境移植到另一种环境所要求的用户程序,用户接口兼容方面的约束等等。

6.3.1.4.5 警告

指定所需属性十分重要,它使得人们能用规定的方法去进行客观的验证。

6.3.1.5 外部接口要求

6.3.1.5.1 用户接口

提供用户使用软件产品是地的接口需求。例如,如果系统的用户通过显示终端进行操作,就必须指定如下要求:

a. 对屏幕格式的要求;

b. 报表或菜单的页面打印格式和内容;

c. 输入输出的相对时间;

d. 程序功能键的或用性。

6.3.1.5.2 硬件接口

要指出软件产品和系统硬部件之间每一个接口的逻辑特点。还可能包括如下事宜:支撑什么样的设备,如何支撑这些设备,有何约定。

6.3.1.5.3 软件接口

在这里应指定需使用的其他软件产品(例如,数据管理系统,操作系统,或者数学软件包),以及同其他应用系统之间的接口。

对每一个所需的软件产品,要提供如下内容:

a. 名字;

b. 助记符;

c. 规格说明号;

d. 版本号;

e. 来源。

对于每一个接口,这部分应说明与软件产品相关的接口软件的目的,并根据信息的内容和格式定义接口,这里不必详细描述任何已有完整文件的接口,只要引用定义该接口的文件即可。

6.3.1.5.4 通信接口

这里指定各种通信接口,例如,局部网络的协议等等。

6.3.1.6 其他需求

根据软件和用户组织的特性等,某些需求放在下面各项中描述。

6.3.1.6.1 数据库

本项对作为产品的一部分进行开发的数据库规定一些需求,它们可能包括:

a. 在6.3.1.1条中标识的信息类别;

b. 使用的频率;

c. 存取能力;

d. 数据元素和文卷描述符;

e. 数据元素、记录和文卷的关系;

f. 静态和动态的组织;

g. 数据保存要求。

注:如果使用一个现有的数据库包,这个包应在“软件接口”中命名,并在那里

详细说明其用法。

6.3.1.6.2 操作

这里说明用户要求的常规的和特殊的操作。

a. 在用户组织之中各种方式的操作。例如,用户初始化操作;

b. 交互作用操作的同期和无人操作的周期;

c. 数据处理支持功能;

d. 后援和恢复操作。

注:这里的内容有时是用户接口的一部分。

6.3.1.6.3 场合适应性需求

这里包括:

a. 对给定场合、任务或操作方式的任何数据或初始化顺序的需求进行定义。例如,栅值,安全界限等等。

b. 指出场合或相关任务的特点,这里可以被修改以使软件适合特殊配制的要求。

6.3.2 具体要求的组织

本条通常是SRS所有部分中最大并且最复杂的部分。

a. 可以根据软件实现功能的基本类型,将本条分成若干段。例如:考虑一个大的交互记帐系统,在里层可以分为操作软件(它支持近乎实时的事务处理)、支撑软件(联机功能、磁盘备份、装入磁带等等)以及诊断软件(诊断硬件、通信等),外一层是应收款帐以及应付款帐等等;

b.结构细分的目的是提高SRS的可读性,而不是进行概要设计。

对于SRS中的第3章的具体需求部分的最好的组织方案取决于所说明的软件产品的应用范围和性质。

表2~表5提供了四种可能的组织方案。

a. 大纲1(表2)中首先说明全部功能需求,然后说明四种类型的接口要求,最后是其他需求;

b. 大纲2(表3)中,把对应每个特定功能的四种接口需求和该功能需求放在一起描述,然后说明其他需求;

c. 大纲3(表4)中,与功能需求有关的全部内容放在一起首先说明,然后是其他需求的描述。对每一种外部接口的需求重复上述过程;

d. 大纲4(表5)中,接口需求和其余的需求作为每一个功能需求的附属部分来说明。

SRS的具体需求的组织形式必须选择可读性最好的方法来描述。

6.4 支持信息

支持信息是指目录表,附录和索引。以便使SRS易于使用。

6.4.1 目录表和索引很重要,而且应按照可以接受的好的文件规则来编写。6.4.2 对一个实际的需求规格说明来说,若有必要应该编写附录。附录中可能包括:

a. 输入输出格式样本,成本分析研究的描述或用户调查结果;

b. 有助于理解SRS的背景信息;

c. 软件所解决问题的描述;

d. 用户历史、背景、经历和操作特点;

e. 交叉访问表。按先后次序进行编排,使一些不完全的软件需求得以完善(参

见4.3.2条和4.3.3条);

f. 特殊的装配指令用于编码和媒体,以满足安全、输出、初始装入或其他要求。

6.4.3 当包括附录时,SRS必须明确地说明附录是不是需求要考虑的部分。

对我有用[0] 丢个板砖[0] 引用举报管理TOP

microhell

(microhell)

等级:

#15楼得分:0回复于:2003-04-29 02:57:00表2 SRS第3章大纲1

3 具体需求

3.1 功能需求

3.1.1 功能需求1

3.1.1.1 引言

3.1.1.2 输入

3.1.1.3 加工

3.1.1.4 输出

3.1.2 功能需求2

……

3.1.n 功能需求n

3.2 外部接口需求

3.2.1 用户接口

3.2.2 硬件接口

3.2.3 软件接口

3.2.4 通信接口

3.3 性能需求

3.4 设计约束

3.4.1 其他标准的约束

3.4.2 硬件的限制

…………

3.5 属性

3.5.1 安全性

3.5.2 可维护性

…………

3.6 其他需求

3.6.1 数据库

3.6.2 操作

3.6.3 场合适应性

程序流程图编写规范_(终极整理版)

程序流程图规范 1.引言 国际通用的流程图形态和程序: 开始(六角菱型)、过程(四方型)、决策(菱型)、终止(椭圆型)。在作管理业务流程图时,国际通用的形态:方框是流程的描述;菱形是检查、审批、审核(一般要有回路的);椭圆一般用作一个流程的终结;小圆是表示按顺序数据的流程;竖文件框式的一般是表示原定的程序;两边文件框式的一般是表示留下来的资料数据的存储。 2.符号用法 程序流程图用于描述程序内部各种问题的解决方法、思路或算法。 图1-1 标准程序流程图符号 1)数据:平行四边形表示数据,其中可注明数据名、来源、用途或其 它的文字说明。此符号并不限定数据的媒体。 2)处理:矩形表示各种处理功能。例如,执行一个或一组特定的操作,

从而使信息的值,信息形式或所在位置发生变化,或是确定对某一流向的选择。矩形内可注明处理名或其简要功能。 3)特定处理:带有双纵边线的矩形表示已命名的特定处理。该处理为 在另外地方已得到详细说明的一个操作或一组操作,便如子例行程序,模块。矩形内可注明特定处理名或其简要功能。 4)准备:六边形符号表示准备。它表示修改一条指令或一组指令以影 响随后的活动。例如,设置开关,修改变址寄存器,初始化例行程序。 5)判断:菱形表示判断或开关。菱形内可注明判断的条件。它只有一 个入口,但可以有若干个可供选择的出口,在对符号内定义各条件求值后,有一个且仅有一个出口被激活,求值结果可在表示出口路径的流线附近写出。 6)循环界限:循环界限为去上角矩形或去下角矩形,分别表示循环的 开始和循环的结束。一对符号内应注明同一循环标识符。可根据检验终止循环条件在循环的开始还是在循环的末尾,将其条件分别在上界限符内注明(如:当A>B)或在下界限符内注明(如:直到C

(国内标准)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. 控制精度或生产能力的提高。

软件技术文档编写规范

目录 第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言 引言提出了对软件需求规格说明的纵览,这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的 对产品进行定义,在该文档中详尽说明了这个产品的软件需求,包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系,那么就只定义文档中说明的部分或子系统。 §1.2 文档约定

描述编写文档时所采用的标准或排版约定,包括正文风格、提示区或重要符号。例如,说明了高层需求的优先级是否可以被其所有细化的需求所继承,或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议 列举了软件需求规格说明所针对的不同读者,例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围 提供了对指定的软件及其目的的简短描述,包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献 列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档,或相关产品的软件需求规格说明。在这里应该给出详细的信息,包括标题名称、作者、版本号、日期、出版单位或资料来源,以方便读者查阅这些文献。 如: a.本项目的经核准的计划任务书或合同、上级机关的批文; b.属于本项目的其他已发表的文件; c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 第2章综合描叙 这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景 描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员,是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品,或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分,那么就要说明这部分软件是怎样与整个系统相关联的,并且要定义出两者之间的接口。 §2.2 产品的功能 概述了产品所具有的主要功能。其详细内容将在 d 中描述,所以在此只需要概略地总结,例如用列表的方法给出。很好地组织产品的功能,使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系,例如数据流程图的顶层图或类图,都是有用的。 §2.3 用户类和特征 确定你觉得可能使用该产品的不同用户类并描述它们相关的特征(见第7 章)。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境 描述了软件的运行环境,包括硬件平台、操作系统和版本,还有其它的软件组件或与其共存的应用程序。

公司技术文档格式规范

目录 一、页边距设置 (3) (一)、装订 (3) (二)、不装订 (3) 二、页面布局设置 (3) 三、目录 (3) (一)、目录选择 (3) (二)、字体 (3) (三)、段落 (3) 四、标题 (4) (一)、“字体”设置 (4) 1、主标题 (4) 2、副标题 (4) (二)、“段落” (4) 五、结构编号 (4) (一)、形式 (4) (二)、字体、段落 (5) 1、一级编号 (5) (1)、“字体” (5) (2)、“段落” (5) 2、二级编号 (5) (1)、“字体” (5) (2)、“段落” (5) 3、三级编号 (6) (1)、“字体” (6) (2)、“段落” (6) 4、四级编号 (6) (1)、“字体” (6) (2)、“段落” (6) 六、正文 (7) (一)、字体 (7) (二)、段落 (7)

(三)、落款、日期、签名规定 (7) (四)、图片 (7) (五)、附件 (9) 七、表格 (10) (一)、Excel电子表格。 (10) 1、页边距 (10) 2、标题 (10) 3、内容 (10) (1)、表头 (10) (2)、内容 (10) 4、列宽 (10) (二)、Word表格 (10) 八、页眉页脚 (11) (一)、格式 (11) (二)、内容 (11) 1、页眉 (11) 2、页脚 (12)

公司技术文档格式规范一、页边距设置 (一)、装订 纵向:上3cm,下2.5cm,左2.7cm,右2.5cm。 横向:上3cm,下2.5cm,左2.5cm,右2.5cm。 (二)、不装订 纵向:上3cm,下2.5cm,左2.5cm,右2.5cm。 横向:上3cm,下2.5cm,左2.5cm,右2.5cm。 二、页面布局设置 布局——页面设置——文档网格 选择“指定文档网格”,设置行数为每页40行。 三、目录 (一)、目录选择 使用引文目录,自动目录1. (二)、字体 “目录”两字:字体,宋体;字形,加粗;字号,四号。居中目录内容:字体,宋体;字形,不加粗;字号,五号。(三)、段落 自定义目录选项下修改目录段落格式。

软件开发过程文档规范

1.1需求规格说明书 需求规格相当于软件开发的图纸,一般说,软件需求规格说明书的格式可以根 据项目的具体情况采用不同的格式,没有统一的标准。下面是一个可以参照的 软件需求规格说明书的模板。 1.导言 1.1目的 [说明编写这份项目需求规格的目的,指出预期的读者] 1.2背景 说明: a)待开发的产品名称; b)本项目的任务提出者、开发者、用户及实现该产品的单位; c)该系统同其他系统的相互来往关系。 1.3缩写说明 [缩写] [缩写说明] 列出本文件中用到的外文首字母组词的原词组。 1.4术语定义 [术语] [术语定义] 列出本文件中用到的专门术语的定义。 1.5参考资料 [编号]《参考资料》[版本号] 列出相关的参考资料。 1.6版本更新信息 具体版本更新记录如表所列。 表版本更新记录 2.任务概述 2.1 系统定义 本节描述内容包括: ●项目来源及背景; ●项目要达到的目标,如市场目标、技术目标等; ●系统整体结构,如系统框架、系统提供的主要功能,涉及的接口等; ●各组成部分结构,如果所定义的产品是一个更大的系统的一个组成部分, 则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张 方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2 应用环境 本节应根据用户的要求对系统的运行环境进行定义,描述内容包括: ●设备环境; ●系统运行硬件环境;

●系统运行软件环境; ●系统运行网络环境; ●用户操作模式; ●当前应用环境。 2.3 假定和约束 列出进行本产品开发工作的假定和约束,例如经费限制、开发期限等。列出本产品的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长以及本产品的预期使用频度等重要约束。 3.需求规定 1.1对功能的规定 本节依据合同中定义的系统组成部分分别描述其功能,描述应包括: ●功能编号; ●所属产品编号; ●优先级; ●功能定义; ●功能描述。 1.2对性能的规定 本节描述用户对系统的性能需求,可能的系统性能需求有: ●系统响应时间需求; ●系统开放性需求; ●系统可靠性需求; ●系统可移植性和可扩展性需求; ●系统安全性需求; ●现有资源利用性需求。 1.2.1精度 说明对该产品的输入、输出数据精度的要求,可能包括传输过程中的精度。 1.2.2时间特性要求 说明对于该产品的时间特性要求,如对: a)响应时间; b)更新处理时间; c)数据的转换和传送时间; d)计算时间等的要求。 1.2.3灵活性 说明对该产品的灵活性的要求,即当需求发生某些变化时,该产品对这些变化的适应能力,如: a)操作方式上的变化; b)运行环境的变化; c)同其他系统的接口的变化; d)精度和有效时限的变化; e)计划的变化或改进。 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。 1.3输入输出的要求 解释各输入输出的数据类型,并逐项说明其媒体、格式、数值范围、精度等。 对软件的数据输出及必须标明的控制输出量进行解释并举例,包括对硬拷贝报

软件开发 软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》(GB 8567—88)是一份指导性文件。它建议在软件的开发过程申编下述14个文件:可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示,它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是:说明该软件开发项目的实现在技术上、经济上和社会条上的可行性,论述为了合理地达到开发目标而可能选择的各种方案,说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式,并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来,以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解, 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息,其内容要求列于表4中。 表4 数据要求说明书

5、概要设计说明书 概要设计说明书又称为总体设计说明书,编制目的是说明对项目系统的设计考虑,包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等,为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明,编制目的是说明一个软件系统各个层次中的每一个程序(模块)的设计考虑。 如果软件系统比较简单,层次少,本文件可以不单独编写,有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书

软件开发技术文档编写规范

软件开发技术文档编写规范 在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。 ◇项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书(软件规格说明书):对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。 ◇概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。 ◇详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。 ◇用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。 ◇测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。 ◇开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。 ◇软件维护手册:主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。 ◇软件问题报告:指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。 ◇软件修改报告:软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。 1可行性分析报告 1 引言 1.1 编写目的:阐明编写可行性研究报告的目的,提出读者对象。

ISO软件开发全套文档~软件开发过程控制程序

北京易游无限科技公司 https://www.doczj.com/doc/0814231248.html, EUWX/QP 0714 软件开发过程控制控制程序 授控状态: 版号:A/O 分发号: 持有人: 2007年8月6日发布2007年8月6日实施

易游无限科技发布 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页

为保证软件产品及其文档可维护,软件开发过程得到有效控制,特制定本程序。 2适用范围 本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3.1需求分析:(引用GB/T11457-1995的2.404)研究用户要求以得到系统或软件需求定义的过程。 3.2概要设计:(引用GB/T11457-1995的2.343)分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义,并提出时间和规模方面的估计。 3.3详细设计:(引用GB/T11457-1995的2.147)推敲并扩充概要设计,以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述,直到设计完善到足以能实现的地步。 3.4设计实现:(引用GB/T11457-1995的2.229)把设计翻译成代码,然后对此代码排除隐错的过程。它是程序的一种机器可执行形式,或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4.1项目负责人:负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4.2需求分析员:作为开发方的代表,负责沟通用户和开发人员的认识和见解,明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4.3系统设计员:负责把软件需求变换成可表示的可实现的软件形式,为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》,完成《系统指南》的编写。 4.4程序员:按设计要求把软件的详细设计变换成可执行的源程序,进行调试。完成相应的文档,编写《用户操作手册》。 4.5测试人员:负责制定测试计划,设计测试方案,测试用例,并实施测试。 4.6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序 软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页

技术文档模板

输入文档名称 内部文件:[输入文件版本号] 颁布时间:[输入颁布时间]

目录 文件版本说明 (2) 参考资料 (2) 手册目的 (2) 声明 (2) 名词定义和缩略语说明 (2) 1 [输入第一章标题] (3) 1.1 [输入第一章第一节标题] (3) 1.1.1 [输入第一章第一节第一小节标题] (3) 1.1.2 [输入第一章第一节第二小节标题] (3) 1.2 [输入第一章第二节标题] (3) 2 [输入第二章标题] (4) 2.1 [输入第一章第一节标题] (4) 2.2 [输入第一章第二节标题] (5) 表格 表 1-1 [输入表格标题] (3) 表 1-2 [输入表格标题] (3) 图表 图1-1 [输入图片名称] (4) 图2-1 [输入图片名称] (4)

文件版本说明 表 1 版本说明 参考资料 1.[列出参考资料名称] 2.[列出参考资料名称,需增加参考资料项,请在行末回车] 手册目的 [请对撰写本手册目的进行适当描述] 声明 [对本文档内容进行声明] 名词定义和缩略语说明 表 2 名词定义及缩略语说明

1[输入第一章标题] [输入正文] 1.1 [输入第一章第一节标题] [输入正文] 1.1.1[输入第一章第一节第一小节标题] [输入正文] 表 1-2 [输入表格标题] 1.1.2[输入第一章第一节第二小节标题] [输入正文] 1.2 [输入第一章第二节标题] [输入正文]

图1-1 [输入图片名称] 2[输入第二章标题] [输入正文] 2.1 [输入第一章第一节标题] [输入正文] 图2-1 [输入图片名称]

软件过程规范示例

编者说明: 软件过程管理中的一个很重要的工作就是制定项目、组织的过程规范,它是软件开发组织行动的准则与指南。该文档就是一个实际的过程规范的实例,通过该实例,相信对大家根据自身情况制定符合要求的项目过程规范、组织过程规范有很好的借鉴作用。 1.总则 最大限度提高Q&P(质量与生产率),提高Q&P的可预见性,是每一个软件开发机构的最大目标。而Q&P依赖于三个因素:过程、人和技术,因此要实现Q&P的提高,除了加强技术能力,引进、培育更多优质技术人才之外,规范、改进机构的过程是一个十分重要的手段。我们希望通过在制定软件过程规范标准,并在软件开发实践中不断地完善、修订,提高Q&P和Q&P的可预见性。 本规范采用CMM(软件过程成熟度模型)的指导,吸收RUP、XP、MSF、PSP、TSP等过程规范指南的思想、方法及实践,充分结合xxx 技术开发部的实际情况,引入先进的技术、方法、工具,为公司的软件开发工作提供一部详细、可操作的过程指南。在本规范的第一版本中,主要包括管理过程和开发过程两个部分,管理过程中包括项目管理过程、需求变更管理过程、配置管理过程。对于软件开发项目中的其它的一些过程将在实践中逐步补充、完善。

2.项目管理过程规范 项目管理过程主要包括三个阶段:项目立项与计划、项目实施、项目关闭。 项目立项与计划 参与人员:技术开发部指定的项目负责人(包括前期负责人、正式的项目经理)、立项申请人、[相关最终客户]以及实施该项目的开发组队成员; 入口准则:接到经公司总经理或副总经理批准的市场部门的《软件开发立项申请表》; 出口准则:立项申请人签字确认了经修订正后的正式《软件项目计划》,并通过《工作任务卡》下达了开发任务,开发工作正式开始;输入:经审批的《软件开发立项申请表》、与需求相关的业务资料;输出:《软件项目计划》、《软件需求规格说明书》、《开发任务卡》;活动: 接到《软件开发立项申请表》后,技术开发部经理指定前期负责人,并告知立项申请人; 前期负责人阅读《软件开发立项申请表》后,通过与立项申请人的沟通、阅读立项申请人提交的材料、通过立项申请人与客户直接交流

技术文件资料编写内容

第六部分供应商须知附表 序号容说明与要求 1 采购人名称省地质环境监测总站 2 供应商的资质要求具备三级以上(含三级)物业服务企业资质 3供应商应提交的商务文件 (1) ★报价函; (2) ★法定代表人授权委托书,如法定代表人参加报价, 提供法定代表人复印件; (3) ★营业执照副本复印件; (4) ★按照“供应商的资质要求”规定提交相关证明材料 复印件; (5)用于评审的证明材料: 1)小型、微型企业产品价格需扣除的,须提供: ①《中小企业声明函》、《从业人员声明函》; ②上一年度资产负债表、损益表的复印件。 ③如供应商为监狱企业,须提供省级以上监狱管理局、戒 毒管理局(含生产建设兵团)出具的属于监狱企业的 证明文件复印件。 (6)供应商认为需要提供的其他商务文件; 4供应商应提交的技术文件

(7) ★报价一览表; (8) ★报价明细表 (9)服务规偏离表; (10)供应商自行编写的技术文件: ①提供详细可行的服务方案,包括但不限于保洁绿化、秩序维护、设备运行维护、会议室服务、物业档案管理方 案等; ②确保顺利接管的措施; ③管理制度; ④培训方案; ⑤优惠服务承诺; (11)投标人认为需要提供的其他技术文件。 5 供应商应单独提交的文件 单独密封的报价一览表(2 份),均须加盖供应商公章,否则作无效报价处理;单独密封的报价保证金退付表。 6 是否允许联合体报价不允许。 7 是否允许供应商将项目非主体、 非关键性工作交由他人完成 不允许。 8 是否安排现场踏勘是,联系人:笑泉。 9 中小微型企业有关政策

(1)根据工信部等部委发布的《关于印发中小企业划型标准规定的通知》(工信部联企业[2011]300 号)规定执行; (2) 按照《财政部司法部关于政府采购支持监狱企业发展有关问题的通知》(财库【2014】68 号)文件规定,在政府采购活动中,监狱企业视同小型、微型企业,享受评审中价格扣除的政府采购政策。 (3)价格扣除幅度:价格给予8%的扣除。 10 项目预算人民币陆拾伍万元整(¥650,000 元)。 11 报价保证金额人民币壹万叁仟元整(13,000 元)。 12 履约保证金 (1)合同金额的10%,于签订合同前交纳; (2)服务期满无质量问题后退还。 13 公证费/见证费 中标金额的0.8‰(如金额低于500 元的,按500 元计算,金额高于8000 元的,按8000 元计算),于签订合同前向公证机构/律师事务所交纳。 14 付款途径预算国库集中支付 15 付款方式 其他支付方式合同生效之日起20 个工作日,支付合同 金额的25 %;服务期限自第二季度起, 每季度末验收合格支付合同金额的25% 16 接管时间合同生效之日起7 日

软件测试文件编制规范

计算机软件测试文件编制规范 1 引言 1.1 目的和作用 本规范规定一组软件测试文件。测试是软件生存周期中一个独立的、关键的阶段,也是保证软件质量的重要手段。为了提高检测出错误的几率,使测试能有计划地、有条不紊地进行地进行,就必须要编制测试文件。而标准化的测试文件就如同一种通用的参照体系,可达到便于交流的目的。文件中所规定的内容可以作为对测试过程完备性的对照检查表,故采用这些文件将会提高测试过程的每个阶段的能见度,极大地提高测试工作的可管理性。 1.2 适用对象及范围 本规范是为软件管理人员、软件开发人员和软件维护人员、软件质量保证人员、审计人员、客户及用户制定的。 本规范用于描述一组测试文件,这些测试文件描述测试行为。本规范定义每一种基本文件的目的、格式和内容。所描述的文件着重于动态测试过程,但有些文件仍适用其它种类的测试活动。 本规范可应用于数字计算机上运行的软件。它的应用范围不受软件大小、复杂度或重要性的限制,本规范既适用于初始开发的软件测试文件编制,也适用于其后的软件产品更新版本的测试文件编制。 本规范并不要求采用特定的测试方法学、技术及设备或工具。对文件控制、配置管理或质量保证既不指明也不强制特定的方法学。根据所用的方法学,可能需要增加别的文件(如“质量保证计划”)。 本规范既适用于纸张上的文件,也适用于其它媒体上的文件。如果电子文件编制系统不具有安全的批准注册机制,则批准签字的文件必须使用纸张。 2 引用标准 GB/T 11457 软件工程术语 GB 8566 计算机软件开发规范 GB 8567 计算机软件产品开发文件编制指南 3 定义 本章定义本规范中使用的关键术语。 3.1 设计层design level 软件项的设计分解(如系统、子系统、程序或模块)。 3.2 通过准则pass criteria 判断一个软件项或软件特性的测试是否通过的判别依据。 3.3 软件特性software feature 软件项的显著特性。(如功能、性能或可移植性等)。 3.4 软件项software item 源代码、目标代码、作业控制代码、控制数据或这些项的集合。 3.5 测试项test item 作为测试对象的软件项。 4 概述

ISO软件开发全套文档-配置管理计划编写指南

产品/项目系统名称 配置管理计划 北京XXXX有限公司 200 年××月 1引言 1.1编写目的

编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款,以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域; c.项目来源、主管部门等 1.3定义 列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料 列出涉及的参考资料。 2 管理 描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构 描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。 说明项目和自项目与其他有关项目之间的关系。 指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务 描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作,并指出各阶段的阶段产品应存放在哪一类软件库中(软件开发库、软件受控制库或软件产品库)。 2.3 职责 指出负责各项软件配置管理任务(如配置标识、配置控制、配置状态记录以及配置的评审与检查)的机构的职责; 指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。 说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。 指出与项目开发有关的各机构的代表的软件配置管理职责。 指出与其他特殊职责,例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项(SCI) 包括: 1.系统约定 2.软件项目计划 3.软件需求文档 4.用户手册 5.设计文档

公司技术文档格式规范

目录 一、页边距设置 (4) (一)、装订 (4) (二)、不装订 (4) 二、页面布局设置 (4) 三、目录 (4) (一)、目录选择 (4) (二)、字体 (4) (三)、段落 (4) 四、标题 (5) (一)、“字体”设置 (5) 1、主标题 (5) 2、副标题 (5) (二)、“段落” (5) 五、结构编号 (5) (一)、形式 (5) (二)、字体、段落 (6) 1、一级编号 (6) (1)、 “字体” (6) (2)、 “段落” (6) 2、二级编号 (6) (1)、 “字体” (6) (2)、 “段落" (6) 3、三级编号 (7) (1)、 “字体” (7) (2)、 “段落” (7) 4、四级编号 (7) (1)、 “字体” (7) (2)、 “段落" (7) 六、正文 (8) (一)、字体 (8) (二)、段落 (8)

(三)、落款、日期、签名规定 (8) (四)、图片 (8) (五)、附件 (10) 七、表格 (11) (一)、Excel电子表格。 (11) 1、页边距 (11) 2、标题 (11) 3、内容 (11) (1)、表头 (11) (2)、内容 (11) 4、列宽 (11) (二)、Word表格 (11) 八、页眉页脚 (12) (一)、格式 (12) (二)、内容 (12) 1、页眉 (12) 2、页脚 (13)

公司技术文档格式规范一、页边距设置 (一)、装订 纵向:上3cm,下2。5cm,左2.7cm,右2.5cm。 横向:上3cm,下2.5cm,左2。5cm,右2.5cm。 (二)、不装订 纵向:上3cm,下2。5cm,左2.5cm,右2.5cm。 横向:上3cm,下2。5cm,左2.5cm,右2.5cm。 二、页面布局设置 布局—-页面设置-—文档网格 选择“指定文档网格”,设置行数为每页40行。 三、目录 (一)、目录选择 使用引文目录,自动目录1。 (二)、字体 “目录”两字:字体,宋体;字形,加粗;字号,四号。居中目录内容:字体,宋体;字形,不加粗;字号,五号. (三)、段落 自定义目录选项下修改目录段落格式。

软件开发过程规范

软件开发过程规范 第一部分软件需求分析规范 1、引言 本标准规定了软件需求分析阶段的任务、过程和相关要求,以及需求分析阶段的完成标志。它是软件开发规范的组成部分。 本标准适用于软件需求分析阶段的所有任务和相关人员,包括项目管理人员、软件需求分析人员、文档编制人员和质量审核人员。 2、参考文献 2.1GB8566-88 计算机软件开发规范 2.2ISO/IEC 12207:1995 信息技术——软件生存周期过程 2.3GXB 02-001 软件开发规范:第一部分软件生存周期 2.4GXB 01-001 软件工程术语 2.5GXB 02-007 软件测试规范 3、术语 本标准的术语的定义与GXB 01-001软件工程术语中的定义相一致。 4、需求分析的任务和过程 4.1需求分析任务 确定被开发软件的运行环境、功能、性能和数据需求,建立确认测试准则,编写用户手册,为概要设计提供需求说明书。 4.2需求分析过程 需求分析过程由下列步骤组成: 1)确定需求分析方法和工具; 2)人员培训; 3)确定需求分析输入;

4)需求分析; 5)制定确定测试计划; 6)修改开发计划; 7)编制文档; 8)需求分析审查; 9)需求分析文档存档。 5、总体要求 5.1用户参与 软件需求分析应该有客户指定的人员参加。 5.2用户确认 需求说明必须明确,经过客户同意,并用合同的方式予以确认。 5.3面向用户描述需求 应以用户能够理解的形式和术语描述需求,以利于与用户沟通。 6、需求分析流程 6.1确定需求分析方法和工具 选定合适的需求分析方法,在一个软件项目内所用的分析方法应该保持一致性。候选分析方法: 1)结构分析方法,包括面向数据流的分析方法和面向数据结构的分析方法。 2)面向对象的分析方法。 在需求分析方法选定后,应确定支持该方法的工具。在一个软件项目内,需求建模语言和工具应该保持一致性和规范化。 6.2人员培训 针对所选定的设计方法和工具,以及相关的标准对需求人员进行相应的培训。这是一个可选项,但对于新的方法和工具,或新的分析人员,培训是必需的。

软件文档编写指南

《计算机软件文档编写指南》 一.计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式: 密级:编号: 文档名称: 项目名称: 编制: 审核: 批准: ×××××××××××××研究所 年月日

二.计算机软件文档包括: 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.服务(阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。)

软件开发文档编写规范

附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.编写目的(阐明编写总结报告的目的,指明读者对象。)

软件设计流程及编写规范

一、前期方案评估 1、主控芯片选型 模块化控制要求,整理系统需要的资源。如系统时钟、普通IO拟需要的数目、中断源的个数、AD采样通道的个数、PWM输出的通道数等。在封装等外形尺寸等符合硬件标准的情况下,从上述方面去考虑主控芯片的型号,优先考虑行业通用或是编程人员熟悉的芯片类型。 对于无参考的新品项目,在做方案时必须对主控芯片的资源做预留,以备功能扩展或是方案更改需要。如至少留出2个以上的普通IO口,1个以上的AD转换口,1个以上的中断资源。 2、主控芯片性能粗测试 初期选型通过的主控芯片,DIY一张DEMO实验板,编写测试程序测试所选芯片是否符合工程需要。主要测试单片机的如下性能: 1)系统时钟的稳定性 2)指令周期 3)端口输入输出延迟 4)极限工作温度区间 5)频漂 6)其它专用功能 经测试后给出测试结论:Y/N。 3、软件方案的制定 3.1 系统资源分配 系统时钟的选择(兼顾系统的运行速度以及实际需求),并非越高越好,如果控制系统要求有精确的定时,优先保证时间精度。如,精确的定时器触发、PWM精确的载波周期等。 依据控制对象的具体情况,把控制需求模块化。对不同的功能模块,采用最适合的单片机资源去实现。对每个模块,详细分析模块的功能以及实现方式,对于核心功能,还需给出软件流程图。如要实现AD采样功能,需给出AD的参考电压、转换通道、转换精度等,并且给出采样值的滤波方法。 3.2 系统结构框架设计 设计系统的工作流程,把各功能模块按照一定的逻辑结构组合成完整的系统,其中包括系统框架图,软件流程图,中断管理等。 对于中断,必须慎重考虑程序被打断后的恢复问题,如程序在运行到AD采样时被某中断打断,中断函数中依然有AD采样,那么在中端函数执行完后,程序在断点继续执行时AD采样寄存器的值已不再是中断执行前的值。 3.3 任务进度安排 指定软件编写责任人以及进度表。相应文档规整,责任人签字确认后存档。

GB 16680-1996 软件文档管理指南

GB/16680-1996软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划,管理者必须关注这些内容,以便有效地管理软件文档。 本标准期望应用于各种类型的软件,从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档,作用于软件生存期的各个阶段。 不论项目的大小,软件文档管理的原则是一致的。对于小项目,可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的,不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文,通过在本标准中引用而构成为本标准的条文。本标准出版时,所示版本均为有效,所有标准都会被修订,使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义,其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如,技术文件、设计文件、版本说明文件。 3.2 文档(集);文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明,它指出文档的范围、内容、格式及质量,可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果,并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据; b) 任务之间联系的凭证; c) 质量保证; d) 培训与参考; e) 软件维护支持; f) 历史档案。 4.1 管理依据 在软件开过过程中,管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

相关主题
文本预览
相关文档 最新文档