CN109597603A - 一种基于文档构件的需求文档自动生成方法 - Google Patents

Abstract

本发明提供了一种基于文档构件的需求文档自动生成方法，包括以下步骤：添加用于描述文档纲要内容的文档纲要构件；加载文档纲要构件使其成为可编辑状态，可编辑状态的文档纲要构件包括功能需求编辑，数据需求编辑以及外部接口环境编辑；编辑文档纲要构件，对于功能需求编辑添加用例构件以对产品界定范围与业务功能做出限定与规划，对于数据需求编辑添加数据构件以对数据做出规范描述，对于外部接口编辑添加外部接口及环境构件以制定需要使用的外部应用接口；对完成编辑的文档纲要构件进行打包封装为需求文档。本发明提高了需求文档的准确性与完整性，攻克了需求开发人员对于需求模糊所致的难题。

Description

一种基于文档构件的需求文档自动生成方法

技术领域

本发明所属技术领域为软件工程领域，涉及文档生成领域，具体涉及一种基于文档构件的需求文档自动生成方法。

背景技术

软件复用，又称为软件重用，是指重复使用“为了复用目的而设计的软件”的过程。软件需求规范是一项困难而复杂的任务，需要需求工程师付出大量的努力。要创建SRS(软件需求规格说明)文档，需求分析人员通常使用需求规范模板，这些模板提供了IS(新信息系统)的功能和非功能需求的一般结构形式。但是，这些模板没有提供与需求发现阶段相关联的特定方向。相反，分析人员常常需要搜索文档，或者对开放的问题进行访谈，需求发现与获取阶段产生的结果往往是一个冗长、无序的文本，带有大量冗余和歧义，分析人员需要对其进行组织并设计选择适合需求规范的模板。需求规格说明文档SRS除了缺乏特异性外，同样也缺乏辅助文档自动生成的工具。

现如今虽有许多CASE(计算机辅助软件工程)工具可以帮助开发软件，但是它们鲜有支持基于NL(自然语言)对需求描述。NL赋予了需求的形式化和编写的表现力，使用户、分析师和程序员容易理解它们。因此市场上投入使用的大部分现有工具的主要关注点是图表和图片而非需求文档文本规范。

现有技术提供了一种文档自动生成方法，根据不同功能需求定制Excel、XML等格式的文档模板，通过获取需求数据与模板匹配后填充，最终根据定义好的格式插件自动生成电子文档。目的是实现自动生成，以克服当前文档主要由人工编写所带来的时间耗费成本高以及工作效率低下等问题。但是，该发明所涉及的文档对象包括各个领域的表格、策划书、设计说明书等等，要求定制不同格式的文档/表格模板至少十种，为囊括所有的文档/表格的标准内容项数达到1000条以上，通过内容数据、模板、模板内编辑区域，三者各自的编号组合以实现自动绑定。由于各个领域的文档适用范围不同，格式与模板要求也不同，该发明中模板的定义与标准内容难以规范、准确，并未在具体应用场景下给出明确示例，灵活性较差，适应范围与实用性存在一定局限。

现有技术中还包括一种复杂文档分离组织方法以及复杂文档的自动生成技术，其能够实现文档大纲、文档数据和文档样式分离，并且不受操作系统环境和文档工具限制自动生成复杂文档。该方法解决了由于传统的文档自动生成技术受文档查看工具和文档编码格式限制，而对文档自动生成开发工具和文档查看工具的依赖性较大的问题。基于XML描述的复杂文档自动生成方法通过对文档内容分组，以及定义样式索引，从而简化复杂文档管理过程。该方法在一定程度上能够减轻用户在撰写复杂格式文档时对文档样式的关注度，但基于XML描述的复杂文档自动生成方法在操作性方面较为复杂，并不能良好适用于软件文档制品开发；此外，该发明方法并未针对软件需求文档的特点对需求的功能、用例、数据描述、性能等方面给出解决方案。

发明内容

本发明目的在于提供一种基于文档构件的需求文档自动生成方法，以解决现有技术中存在的问题。

为解决现有技术中的问题，本发明提供了一种基于文档构件的需求文档自动生成方法，包括以下步骤：

S1：添加用于描述文档纲要内容的文档纲要构件；

S2：加载文档纲要构件使其成为可编辑状态，可编辑状态的文档纲要构件包括功能需求编辑，数据需求编辑以及外部接口环境编辑；

S3：编辑文档纲要构件，对于功能需求编辑添加用例构件以对产品界定范围与业务功能做出限定与规划，对于数据需求编辑添加数据构件以对数据做出规范描述，对于外部接口编辑添加外部接口及环境构件以制定需要使用的外部应用接口；

S4：对完成编辑的文档纲要构件进行打包封装为需求文档。

优选地，文档生成方法还包括以下步骤：

S5：将需求文档上传至文档构件库以实现知识库的构建并为文档重用、知识共享提供基础构件；添加文档纲要构件、添加用例构件、添加数据构件或添加外部接口及环境构件等步骤后的构件均可上传至文档构件库。

优选地，文档纲要构件用于对文档整体框架结构进行定义与限定，具体为通过对需求规格说明文档模板通用结构进行分析，针对需求文档中的通用纲要内容进行封装的构件。

优选地，用例构件的结构模块内容包括：用例名、用例目标、优先级、输入输出、参与角色、用例过程中任意一种或几种的组合。

优选地，数据构件用于描述相关数据的元模型，定义所需使用的数据集的规范与约束，具体包括归纳数据字典，提供规范化的数据描述表示形式用于以为后期开发人员提供参考。

优选地，外部接口及环境构件用于提供规范化软件应用、硬件设备以及通信协议接口，提供调用表示形式以为后期开发人员提供可用API(Application ProgrammingInterface，应用程序编程接口)；外部接口及环境构件还用于对软件系统开发运行环境提供参考与描述以供后期直接交互使用。

优选地，文档纲要构件的结构模块内容包括封面、目录、引言、任务概述、功能需求、数据需求、性能需求、运行环境以及附录中任意一种或几种的组合。

本发明具有以下有益效果：

1、本发明的需求文档自动生成方法以用例表的形式替代了传统“用例图+用例描述”的方式，更加简洁、直观地对场景及用例过程进行全面的描述，业务流程清晰、明确。

2、本发明的需求文档自动生成方法将基于非结构化自然语言文本描述的具体业务功能转化为基于用例表的半结构化数据，业务流程规范、明确。

3、本发明生成的需求文档保存至文档构件库中，以实现软件需求工程阶段文档的有效开发与最大化重用。

除了上面所描述的目的、特征和优点之外，本发明还有其它的目的、特征和优点。下面将参照附图，对本发明作进一步详细的说明。

附图说明

构成本申请的一部分的附图用来提供对本发明的进一步理解，本发明的示意性实施例及其说明用于解释本发明，并不构成对本发明的不当限定。在附图中：

图1为一种基于文档构件的需求文档自动生成方法流程图；

图2为一种基于文档构件的需求文档自动生成方法的文档纲要构件样式效果图；

图3为封装用例构件示意图；

图4为需求文档功能效果图。

具体实施方式

以下结合附图对本发明的实施例进行详细说明，但是本发明可以由权利要求限定和覆盖的多种不同方式实施。

实施例1：

本方法定义了四类文档构件工具：文档纲要构件、用例构件、数据构件和接口及环境构件。以文档纲要构件为框架基础，对文档整体框架结构进行设计与规定；以用例构件为核心，在描述项目需求时采用自定义用例表的方式对功能需求详细描述；数据构件以示例形式在通用场景下提供规范化的数据表示；接口及环境构件主要对软件开发所涉及的常用软件应用、硬件设备、通信协议接口，以及运行环境加以归纳。

参见图1，本发明的一种基于文档构件的需求文档自动生成方法，包括以下步骤：

S1：添加用于描述文档纲要内容的文档纲要构件。

文档纲要构件的结构模块内容包括封面、目录、引言、任务概述、功能需求、数据需求、性能需求、运行环境以及附录中任意一种或几种的组合。

文档纲要构件用于对文档整体框架结构进行设计与规定。文档纲要是对整篇文档结构的宏观描述，它按照内容对文档进行层次化分解、定义和管理，最终实现统一组织。通过对需求规格说明文档模板通用结构进行分析，针对需求文档中的通用大纲内容封装为文档纲要构件。文档纲要构件主要内容包括封面、目录、引言，任务概述，功能需求，数据需求，性能需求，运行环境、附录。文档纲要构件的主要内容的具体描述如下：

封面：产品、开发人员、版本信息、联系方式；

目录：根据纲要结构自动生成；

引言：编写目的、背景、名词定义、项目范围；

任务概述：目标、项目描述、用户特点、假定和约束；

功能需求：总体功能需求描述、功能优先级列表、各功能点用例构件；

数据需求：所涉及数据集总体描述、各数据集数据构件；

接口及运行环境：用户界面、接口构件；

性能需求：数据精度、时间特性、容量需求；

附录：参考文献、图表。

图2为文档纲要构件样式效果图。

S2：加载文档纲要构件使其成为可编辑状态，可编辑状态的文档纲要构件包括功能需求编辑，数据需求编辑以及外部接口环境编辑。

S3：编辑文档纲要构件，对于功能需求编辑添加用例构件以对产品界定范围与业务功能做出限定与规划，对于数据需求编辑添加数据构件以对数据做出规范描述，对于外部接口编辑添加外部接口及环境构件以制定需要使用的外部应用接口。

文档纲要构件用于对文档整体框架结构进行定义与限定，具体为通过对需求规格说明文档模板通用结构进行分析，针对需求文档中的通用纲要内容进行封装的构件；数据构件用于描述相关数据的元模型，定义所需使用的数据集的规范与约束，具体包括设计数据字典，提供规范化的数据描述表示形式用于以为后期开发人员提供参考；外部接口及环境构件用于规范化表示软件应用、硬件设备以及通信协议接口，提供调用表示形式以为后期开发人员提供可用API；外部接口及环境构件还用于对软件系统开发运行环境提供参考与描述以供后期直接交互使用。下表1为用例构件定义表：

表1：

用例构件的结构模块内容包括：用例名、用例目标、优先级、输入输出、参与角色、用例过程中任意一种或几种的组合。用例构件中设定的优先级，最终通过对文档用例库扫描形成项目功能优先级列表。用例构件通过自定义的用例表的形式体现，将基于非结构化自然语言文本描述的具体业务功能需求数据转化为基于用例表的半结构化数据。采用用例表作为工具以代替传统“用例图+用例描述”的方式，简洁、直观地对场景及用例过程进行全面地描述，业务流程清晰、明确。

数据构件用于对数据需求进行描述，以示例形式在通用场景下提供规范化的数据表示。对企业常用的社交类、交易类、管理类软件系统，在数据需求方面不同粒度定义了规范化的数据构件，作为参考、查阅工具。其中：社交类媒体平台主要关注消息留言、评论、转发、收藏、关注；交易类电商平台主要关注订单及交易额度；管理类仓库系统主要关注进货需求及供货用度。

针对各软件系统常用的典型数据集具体分析描述如下，其中，

业务类系统：

人：姓名、ID、性别、生日、身份证、邮箱、地址、手机号、用户名、密码、职务；

书籍：书名、ID、作者、出版社、版本、单价；

商品：item商品编号、商品类型、商品品牌、商品成本、商品售价、商品数量；

酒店：客房ID，房间类型、市价、数量、订房状态；

部门：部门名称、部门编号、部门人数、部门负责人、联系电话、邮箱；

课程：课程名、课程号ID、课时、学分；

订单：订单ID、商品ID、商品名称、买家ID、卖家ID、售价、数量、订单时间、状态；

选课表：编号ID、课程ID、学生学号、选课时间。

仓库类系统：

进货清单：进货编号+进货人员+进货商品+商品品类+进货数量+进货单价+进货时间+生产商；

供货清单：供货编号+供货人员+供货商品+商品品类+供货数量+供货售价+供货时间。

后台管理类：

用户：姓名、ID、性别、生日、身份证、邮箱、地址、手机号、用户名、密码、职务；

角色：role角色ID、角色名、角色描述、创建时间；

权限：Authorization权限ID、权限类型、权限描述；

日志：log日志标号、日志类型、内容、时间戳；

组织：organization组织ID、组织名、组织描述、创建时间、联系电话。

S4：对完成编辑的文档纲要构件进行打包封装为需求文档。

构建完成的构件打包形成与描述文档对应的需求文档。开发人员可以根据需求文档直观、明确的对需求功能进行编码。

S5：将需求文档上传至文档构件库以实现知识库的构建并为文档重用、知识共享提供基础构件；添加文档纲要构件、添加用例构件、添加数据构件或添加外部接口及环境构件步骤后的构件均可上传至文档构件库。

添加文档纲要构件并加载构件内容，可以编辑文档纲要构件的内容，自定义修改描述。文档纲要构件可以直接上传至构件库以供之后进行复用。未编辑的文档纲要构件可应用于大部分软件的需求，编辑后的文档纲要构件则适用于与之编辑类型相似的软件的需求。在文档纲要构件添加完成后，可以进行用例构件、数据构件和外部接口及环境构件的添加，三种之间拥有相同的优先级，任意一种构件添加完成后都可以上传至构件库中以供复用。在完成文档纲要构件、用例构件、数据构件和接口及环境构件添加完成后，还可以对文档纲要构件中的其他性能需求进行编辑。

本发明提出一种基于文档构件的需求文档自动生成方法，以实现软件需求工程阶段文档的有效开发与最大化重用。该发明实现从代码重用到文档重用的过程，反之，可重用的文档构件作为指导，又进一步推进代码重用。

该方法首先以软件需求规格说明书文档为研究对象，基于自然语言的需求文档各个模块特点对其分解、分析，定义四类文档构件——文档纲要构件、用例构件、数据构件、接口及环境构件；然后系统地给出软件需求文档中这四类构件的规范形式，良好地定义与封装以便用户使用；最终运用需求文档构件化的思想提出一种基于自然语言描述的需求文档构件体系模型设计方案，以实现软件需求工程阶段文档的有效开发与最大化重用；提高需求文档的准确性与完整性。

实施例2：

首先获取设定的需求文档纲要模板并加载描述，加载需求文档纲要至编辑状态；然后可根据需要修改、编辑内容；接着在功能描述部分添加、引用用例构件，在此过程中，可添加、编辑用例过程，自定义用例优先级；针对软件系统所涉及的数据集，引用数据构件并添加自定义编辑；针对所需使用的外部应用接口以及运行环境要求，可在接口及环境构件列表中根据所需内容，直接引用已规范定义的构件内容。最终对带样式的文档构件组装并格式化输出为最终需求文档。

应用场景与大体步骤描述如下：

在客户经理或者实施人员经与客户交流协商后，与客户讨论澄清后达成一致需求，将其以文档构件形式录入需求生成系统，最终形成结构完整、描述清晰、结构规范的需求文档。主要包括：

步骤1，添加文档纲要构件，用于获取文档纲要内容；

步骤2，加载构件为可编辑状态，在编辑区域自定义修改描述。其中包括：

封面内容：开发人员、角色、产品、版本信息、联系方式等基本信息；

目录：由纲要模板自适应匹配目录；

正文：包括引言，任务概述，功能需求，数据需求，性能需求，运行环境六大模块。其中，引言模块描述项目由来及知识背景，包括：编写目的、项目背景、名词定义、参考资料；任务概述模块主要对项目定位与市场发展目标进行概述，具体包括：目标、项目描述、用户特点、假定与约束；功能需求模块作为项目核心内容，对产品范围与业务功能做出明确限定与规划，主要包括：总体功能需求描述、功能优先级列表、各功能点用例构件；性能需求模块侧重于产品优化，进一步对产品是否易用、安全、稳定、可兼容等属性做出约束，包括：数据精度、时间特性、容量需求等。

附录：包括文档所涉及的参考文献、引用图表等。

步骤3，功能需求编辑：用于对产品界定范围与业务功能做出明确限定与规划。通过添加用例构件具体描述功能用例；

步骤4，加载构件为可编辑状态，在编辑状态下可自定义用例过程内容，亦可引用构件库中封装好的用例构件直接获取。

其中，用例构件提供用例表作为功能业务描述，主要内容有：

用例名：对用例业务功能处理的概括；

用例目标：明确用例在该场景下实现的功能目标；

优先级：对该用例构件在整体功能清单的地位做出优先级限定，分为：低、中、高三种。最终可对用例构件库中所有构件的优先级扫描以获得功能清单；

输入与输出：对用例场景下该功能模块的输入规定，以及最终预期得到的输出结果；

参与角色：用例参与者；

用例过程：用例参与者在所述场景下为实现功能目标所执行的一系列操作过程，形式如：角色1：执行操作1；

步骤5，数据需求编辑，用于对所需使用到的数据做出规范描述。通过添加数据构件具体描述所需数据集；

步骤6，加载构件为可编辑状态，在该状态下可自定义数据内容，亦可直接引用构件库中封装好的数据构件；

步骤7，外部接口及环境编辑，在产品规划阶段制定可能需要使用的外部应用接口，包括软件应用、硬件设备、运行环境等，点击添加接口及环境构件具体描述；

步骤8，加载构件为可编辑状态，具体描述可通过引用接口构件，从列表中获取相关接口，依据规范使用。

步骤9，其他性能需求编辑，对项目开发中所涉及的数据精度、时间特性、容量需求等质量属性进一步明确。

步骤1-9均可将自定义完成的构件内容一键打包，封装为新的文档构件，并上传至文档构件库以实现知识库的构建。

步骤1-9所述文档构件均可从文档库中引用，加载为可编辑状态，以实现基于构件的文档重用、知识共享。

参见图3与图4，图3与图4分别为实际操作过程中的封装用例构件示意图以及需求文档功能效果图。

以上仅是本发明的优选实施方式，本发明的保护范围并不仅局限于上述实施例，凡属于本发明思路下的技术方案均属于本发明的保护范围。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理前提下的若干改进和润饰，应视为本发明的保护范围。

Claims (7)

1.一种基于文档构件的需求文档自动生成方法，其特征在于，包括以下步骤：

S1：添加用于描述文档纲要内容的文档纲要构件；

S2：加载所述文档纲要构件使其成为可编辑状态，可编辑状态的文档纲要构件包括功能需求编辑、数据需求编辑以及外部接口及环境编辑；

S3：编辑文档纲要构件，对于功能需求编辑添加用例构件，对于数据需求编辑添加数据构件，对于外部接口及环境编辑添加外部接口及环境构件；

S4：对完成编辑的所述文档纲要构件进行打包封装为需求文档。

2.根据权利要求1所述一种基于文档构件的需求文档自动生成方法，其特征在于，所述文档生成方法还包括以下步骤：

S5：将所述需求文档上传至文档构件库以实现知识库的构建并为文档重用、知识共享提供基础构件；添加文档纲要构件、添加用例构件、添加数据构件或添加外部接口及环境构件步骤后的构件均可上传至文档构件库。

3.根据权利要求1所述的一种基于文档构件的需求文档自动生成方法，其特征在于，所述文档纲要构件为通过对需求规格说明文档模板通用结构进行分析后得到的针对需求文档中的通用纲要内容进行封装的构件。

4.根据权利要求1所述的一种基于文档构件的需求文档自动生成方法，其特征在于，所述用例构件的结构模块内容包括：用例名、用例目标、优先级、输入输出、参与角色及用例过程中任意一种或几种的组合。

5.根据权利要求1所述的一种基于文档构件的需求文档自动生成方法，其特征在于，所述数据构件用于描述相关数据的元模型，包括归纳数据字典，和以规范化的数据描述表示形式描述相关数据的元模型。

6.根据权利要求1所述的一种基于文档构件的需求文档自动生成方法，其特征在于，所述外部接口及环境构件用于提供软件应用、硬件设备以及通信协议的接口类型条目以供后期开发人员选择；所述外部接口及环境构件还用于对软件系统开发运行环境提供参考与描述以供后期直接交互使用。

7.根据权利要求3所述的一种基于文档构件的需求文档自动生成方法，其特征在于，所述文档纲要构件的结构模块内容包括封面、目录、引言、任务概述、功能需求、数据需求、性能需求、运行环境描述字段以及附录中任意一种或几种的组合。