基于QT5软件的需求规格说明文档自动生成方法及生成装置

技术领域

本发明涉及软件开发技术领域，尤其涉及一种基于QT5软件的需求规格说明文档自动生成方法及生成装置。

背景技术

国内软件工程化推行以来，软件开发过程会产生大量的软件文档，软件需求规格说明就是其中很重要的一个文档，指导后续软件设计、开发和测试工作，是软件确认测试和验收的依据，既是文档就有格式要求，当前软件需求规格说明的格式要求遵循GJB 438B-2009《军用软件开发文档通用要求》。

按需求颗粒度200行代码一个需求点计算，一个20000行代码的软件需要编制包含100个功能点的软件需求文档，大量的文档编辑工作占需求开发总工作量的30％以上，而且不易维护，很大程度上降低了软件开发效率，影响项目整体完成进度。

发明内容

为解决上述技术问题，本发明实施例期望提供一种基于QT5软件的需求规格说明文档自动生成方法及生成装置。

本发明的技术方案是这样实现的：

一种基于QT5软件的需求规格说明文档自动生成方法，包括如下步骤：步骤1：基于QT5软件设计编辑界面；步骤2：在所述编辑界面输入需求标签，并在对应的所述需求标签内输入对应的需求内容；步骤3：使用QT5软件控制Office软件自动生成符合要求的需求规格说明文档。

优选的，在步骤2中还包括如下步骤，

步骤2.1：根据软件的需求点确定需要输入的需求标签、及与所述需求标签对应的需求内容；

步骤2.2：在所述编辑界面输入对应的所述需求标签和所述需求内容。

优选的，在步骤3中，包括如下步骤：

使用QT5软件控制Office软件自动生成pdf格式或word格式的需求规格说明文档；

如果生成pdf格式的需求规格说明文档，则有使用标准QPrinter类接口创建和生成pdf文件；

如果生成word格式的需求规格说明文档，则有使用ActiveX框架创建和生成COM组件，并编写代码对所述COM组件进行封装，形成word文件操作软件接口。

优选的，在步骤3中，word文件操作接口如下表所示：

。

一种基于QT5软件的需求规格说明文档自动生成装置包括：编辑界面模块，其基于QT5软件设计编辑界面；及文档生成模块，其使用QT5软件控制Office软件自动生成符合要求的需求规格说明文档；其中，在所述编辑界面模块的所述编辑界面输入需求标签，并在对应的所述需求标签内输入对应的需求内容后，所述文档生成模块能够自动生成符合要求的需求规格说明文档。

优选的，根据软件的需求点确定需要输入的需求标签、及与所述需求标签对应的需求内容。

优选的，使用QT5软件控制Office软件自动生成pdf格式或word格式的需求规格说明文档；如果生成pdf格式的需求规格说明文档，则有使用标准QPrinter类接口创建和生成pdf文件；如果生成word格式的需求规格说明文档，则有使用ActiveX框架创建和生成COM组件，并编写代码对所述COM组件进行封装，形成word文件操作软件接口。

本发明的有益效果：

本发明基于QT5软件自主设计了操作简单、便捷的用户界面，该界面所有操作在三次鼠标点击内确定最终编辑焦点，菜单深度最深为一级，一目了然，无需专门的培训即可轻易上手，并操作自如；

本发明基于QT5实现自动依据使用者编辑的需求内容条目多少生成符合需求模板要求的软件需求规格说明文档，可同时导入、编辑、保存和生成多个需求，生成后的需求文档格式统一，标准，节省需求开发人员大量关于文档格式等工作，提高需求开发效率，节省人力成本；

而且，本发明的优点在于释放需求开发人员思想，需求人员不需要关心文档标准及格式问题，只需专注于需求开发内容，可一键生成符合模板或标准的软件文档内容，极大的提高了软件开发的效率。

附图说明

图1为本发明提供的基于QT5的软件需求规格说明文档自动生成方法中界面设计示意图；

图2为本发明提供的基于QT5的软件需求规格说明文档自动生成方法中需求菜单示意图；

图3为本发明提供的基于QT5的软件需求规格说明文档自动生成方法中输出菜单示意图。

具体实施方式

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。

本发明提供一种基于QT5软件的需求规格说明文档自动生成方法，包括如下步骤：

步骤1：基于QT5软件设计编辑界面；

步骤2：在所述编辑界面输入需求标签，并在对应的所述需求标签内输入对应的需求内容；

步骤3：使用QT5软件控制Office软件自动生成符合要求的需求规格说明文档。

具体地，所述编辑界面的界面设计如图1所示：

设置需求标签，不同需求可通过标签进行切换，每次可同时编辑多个需求，设计需求标签“+”、“-”功能，可动态增加和删除需求；

内容编辑区域上部最显眼位置放置需求名称和需求标识，可直接输入进行编辑；

依据软件需求规格说明模板内容，将需求内容按标签(输入、输出、处理过程、前提与约束、容错处理、性能)进行分类；

标签内使用表格方式进行设计，设置了“增加行”和“删除行”按钮，每个标签内内容条目可自由增删。

所述编辑界面的功能设计如图2和图3所示：

“需求”下拉菜单内设计需求导入和保存功能，可对需求开发过程中未完成需求内容以数据文件形式保存在指定位置，下次打开可导入文件继续保存前工作；

“输出”下拉菜单设计“WORD”“PDF”选项，开发人员可选择输出Word格式或PDF格式需求文件。

在步骤2中还包括如下步骤，

步骤2.1：根据软件的需求点确定需要输入的需求标签、及与所述需求标签对应的需求内容；

步骤2.2：在所述编辑界面输入对应的所述需求标签和所述需求内容。

在步骤3中，包括如下步骤：

使用QT5软件控制Office软件自动生成pdf格式或word格式的需求规格说明文档；

如果生成pdf格式的需求规格说明文档，则有使用标准QPrinter类接口创建和生成pdf文件；

如果生成word格式的需求规格说明文档，则有使用ActiveX框架创建和生成COM组件，并编写代码对所述COM组件进行封装，形成word文件操作软件接口。

实际上，在接口设计中，PDF文件使用QPrinter类创建和生成，生成格式符合需求文档模板要求，PDF操作使用标准QPrinter类接口实现；

WORD文件通过Word本身COM组件的形式，使用ActiveX框架来实现创建和生成，编写代码对COM组件进行封装，形成WORD文件操作软件接口，见表1。

表1 word文件操作接口

一种使用基于QT5软件的需求规格说明文档自动生成方法的生成装置，包括编辑界面模块和文档生成模块，所述编辑界面模块是基于QT5软件设计编辑界面，所述文档生成模块使用QT5软件控制Office软件自动生成符合要求的需求规格说明文档。在使用过中，在所述编辑界面模块的所述编辑界面输入需求标签，并在对应的所述需求标签内输入对应的需求内容后，所述文档生成模块能够自动生成符合要求的需求规格说明文档。

在本实施例中，根据软件的需求点确定需要输入的需求标签、及与所述需求标签对应的需求内容。

例如，以静/降噪显控功能为例进行说明，具体如表2所示：

例如，以业务模式显控功能为例进行说明，具体如表3所示：

在本实施例中，将上述表2和表3中的内容输入所述编辑界面模块内，最后使用所述文档生成模块自动生成符合要求的pdf格式或word格式的需求规格说明文档：

如果生成pdf格式的需求规格说明文档，则有使用标准QPrinter类接口创建和生成pdf文件；

如果生成word格式的需求规格说明文档，则有使用ActiveX框架创建和生成COM组件，并编写代码对所述COM组件进行封装，形成word文件操作软件接口。

需要说明的是，使用所述生成装置的步骤如下：

使用者拷贝需求文档自动生成工具的运行包至工作用电脑，选择自定位置存放；

打开运行包，直接双击“需求文档自动生成工具.exe”启动软件或右键->发送快捷方式至桌面，然后通过桌面快捷方式启动软件(推荐)；

点击需求菜单->导入，导入保存的需求开发文件，

点击需求标签选择对应需求，编辑需求内容；

所有需求编辑完成，点击输出菜单->WORD或PDF选项，生成对应需求文件；

需求未编辑完成，暂停工作，可点击需求菜单->保存选项，保存需求编辑数据文件到指定位置，若为保存直接关闭软件，工具会自动保存需求编辑数据文件至默认路径(根目录)，防止误操作导致数据丢失。

以上所述，仅为本发明的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到的变化或替换，都应涵盖在本发明的保护范围之内。因此，本发明的保护范围应以所述权利要求的保护范围为准。