优秀软件需求文档编写指南

《优秀软件需求文档编写指南》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、优秀软件需求文档编写指南V1.0优秀需求具有的特性■需求陈述的特征:1.完整性2.正确性3.可行性4.必要性5.划分优先级6.无二义性7.可验证性8.—致性9可修改性10可跟踪性推荐的编写需求文档的指南：定义标准的文档结构说明如何使用文档包含T需求概要构造系统的业务案例定义专业术语安排好文档的版面使文档易读帮助读者查找信息使文档易于变更推荐的需求描述指南:定义描述需求的标准模板使用浅显、一致、简明的语言适当地使用图解其他需求描述辅助自然语言定量说明需求惟一地标识每个需求记录需求源需求的理由L定义标准的文档结构:为需求确定恰当的结构可有助于：-有利于读者阅读-最小化需

2、求的总量；-大量信息;-找出与具体问题有关的需求集合；-发现遗漏和重复；-消除需求之间的矛盾；-管理迭代（例如延迟提岀的需求）;-拒绝差的需求;一刚古需求；-在多个项目中重用需求。-开发软件来支持符合通用标准的需求文档产品定义标准的文档结构:文档一般是分层的，对于多个层次采用节和小节来组织。文档层次是分类的有用结构，确定需求文档结构的一种方式，是使用通过标题结构能够对需求语句编目的节。采用这种方式,需求语句在文档中的位置代表其一级分类。（二级分类可以通过指向其它节的链或通过属性给岀。文档结构・IEEE/ANSI1830-1993a.引言a.l目的a.2文档约定a.3

3、预期的读者^阅读建议a.4产品的范围a.5参考文献b综合描述b.l产品的前景b.2产品的功能b.3用户类和特征b.4运行环境b.5设计和实现上的限制a.6假设和依赖b.外部接口需求C.1用户界面a.2硬件接口a.3软件接口a.4通信接口b.系统特性b.l说明和优先级b.2激励/响应序列c.3功能需求d.其它非功能需求e丄性能需求c.2安全设施需求c.3安全性需求c.4软件质量属性e.5业务规则e.6用户文档f.其它需求附录A:词汇表附录B:分析模型附录C:待确定问题的列表文档结构-组织特殊信息系统的概述和开发该系统的效益解释所使用的技术术语的术语表系统服务或功能需求

4、的定义系统特性或如可靠性、安全性等非功能性需求的定义系统操作和系统开发过程的约束系统的操作环境和该环境可能变更的走义详细的系统规格说明，它被表示成表示系统组件之间关系的系统模型。2•说明如何使用文档效益-减少阅读的成本-明确知识要求实施-明确所针对不同类型的读者-明确理解文档所需要的专业知识和技术背景-指向概述部分的指示器-明确第一次阅读进可以路过的部分-描述阅读各部分的相关顺序2•包含一个需求概要效益■更易于理解的需求文档-帮助理解概要-关注关键需求，有利于建立需求的优先级-作为文档中的需求的映射，有助于读者发现感兴趣的需求实施-是重要的需求用编号的列表来表示-基

5、于某种分类结构，在表格中列出不同需求-通过把每个主要需求表示成图上的一个结点，可以产生需求的图形化视点3•构造系统的业务案例效益-提供系统需求的一个理由-帮助评估需求变更-帮助理解包含特殊需求的原因实施-放在需求文档引言的单独章节中-列出业务目标-给出目标系统有助于这些业务理由4•定义专业术语效益•避免需求文档的读者与作者之间的误解-帮助读者理解需求文档-帮助不同作者使用相同的术语-减少混淆实施_定义一个标准的术语表-根据术语表修改需求文档-例如：词汇表2•安排好文档版面使文档易读效益・・使文档易读-读的次数比写的次数多，因此-易于评审时发现更好的问题实施-使用宽的

6、页边空白来使文本-节和小节的标题采用一致的格式-少用着重号，一致地使用着重号-使用表格、标号列表或数字列表来表示相关信息项的集合。-当许多信息项必须表示成稳定和变化两部分时，使用表格来显示共同点和不同点。-使用空白把方程式和文本分开，并使用不同字体来表示它们。-如果要描述一系列事件或一个顺序的过程，使用图表来显示过程的各个步骤。-不用使用复杂的图表2•帮助读者查找信息效益■易于用做系统参考-索引和目录容易使需求规格说明作为参考文档-索引帮助读者评审文档实施-生成索引和目录-出现在索引中的术语应在正文中标明-可以使用字处理系统中的自动化工具来创建索引&使用文档易于变更

7、效益■减少需求变更的成本-制作和分发新的需求文档既昂贵又耗时，易于变更的文档可以改变这种情况-有利于及时验证文档实施（结合"安排好文档的版面使文档易读"一起实施）-把文档做成活页-利用字处理系统的修订模式-写文档时，避免引用文档中的其他页码-确保所有图表都有标签，始终使用标签引用图表-保持章简短以便整章可以被用户替换-在单独的页上开始新的一章-始终根据章给页编号-如果有的话，使用使用字处理系统中制作图、表等的相对引用的功能。以便能够自动变更引用。9•定义描述需求的标准模板效益■■需求前后一致，更加易懂-标准使得需求易于阅读-标准使得需求易于收集-标准使得需求易于