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

《软件技术文档编写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、目录第一章引言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

2、用户文档4第六章其他需求4§6.1词汇表4§6.2分析模型4§6.3待确定问题列表5第1章引言　　引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。§1.1目的　　对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。§1.2文档约定　　描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。

3、§1.3预期读者和阅读建议　　列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。§1.4产品的范围　　提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。§1.5参考文献　　列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这

4、里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。第2章综合描叙　　这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。§2.1产品的前景　　描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，

5、是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。§2.2产品的功能　　概述了产品所具有的主要功能。其详细内容将在d中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。§2.3用户类和特征　　确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第

6、7章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。§2.4运行环境　　描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。§2.5设计和实现上的限制　　确定影响开发人员自由选择的问题，并说明这些问题为什么成为一种限制。可能的限制包括如下内容：·必须使用或者避免的特定技术、工具、编程语言和数据库。·所要求的开发规范或标准（例如，如果由客户的公司负责软件维护，就必须定义转包者所使用的设计符号表示和编码标准。·企业策略、政府法规或工业标准。·硬件限制，例如定时需求或存储器限制

7、。·数据转换格式标准。§2.6假设和依赖　　确定影响开发人员自由选择的问题，并说明这些问题为什么成为一种限制。可能的限制包括如下内容：·必须使用或者避免的特定技术、工具、编程语言和数据库。·所要求的开发规范或标准（例如，如果由客户的公司负责软件维护，就必须定义转包者所使用的设计符号表示和编码标准。·企业策略、政府法规或工业标准。·硬件限制，例如定时需求或存储器限制。·数据转换格式标准。第3章外部接口需求　　利用本节来确定可以保证新产品与外部组件正确连接的需求。关联图表示了高层抽象的外部接口。需要把对接口数据和控制组件的详细描述写入数据字典中。如果产品的

8、不同部分有不同的外部接口，那么应把这些外部接口的详细需求并入到这一部分的实例中。§3.1用户界