[发明专利]一种自动生成项目流程文档的方法及系统

说明书

本发明提供了一种自动生成项目流程文档的方法及系统，包括：步骤M1：收集用户动作信息及动作信息相应的接口请求信息，根据用户动作信息及接口请求信息生成树形数据结构T；步骤M2：将树形数据结构T写入包括JSON文件和/或XML文件中，记为DOC1；步骤M3：将DOC1编译成编译成包括Markdown和PlantUML可识别的数据形式，并记为DOC2；步骤M4：将DOC2转化成项目流程文档。本发明解决了开发流程设计文档需要手工编写的问题，同时本发明能自适应项目业务、模块变动，提高了流程文档的准确性。

技术领域

本发明涉及计算机技术领域，具体地，涉及一种自动生成项目流程文档的方法及系统。

背景技术

随着通信和移动终端技术的发展以及广泛应用，各种软件层出不穷。为了能够贴近用户需求，在开发软件产品过程中开发人员根据提供的业务需求确定相应的实现方案。然后根据确定出的相应的实现方案，进行相应的开发。

现有技术方案中，在确定相应的实现方案过程中，产品开发相关的工作人员需要分析业务需求中需要实现的那些功能，并确定对应的流程步骤，并且还需要为每个步骤配置输入和输出参数描述的接口文档，然后在将这些流程步骤和对应的接口文档进行组合，从而得到开发文档。

因为项目流程文档存在业务逻辑的层级关系，所以目前业界大都是手工编写，人工校对。存在自动生成的方案也是定制化制作某个项目的模版，然后根据模版生成项目流程文档。在项目快速迭代时，项目流程文档频繁修改，无论是手工编写还是模版化，都难以保持其和代码的一致性，文档维护成本很高。

针对上述现有技术的不足，本发明提供了可以通过用户操作项目实时生成项目流程文档的方法。在用户操作产品前端界面时，脚本自动收集用户动作信息、接口请求信息，并生成树形数据结构，最终生成项目流程文档。本发明能自适应项目业务、模块变动。但实现上存在一些难题：(1)在用户操作产品前端界面时，用户会跳模块点击、错乱点击和重复点击等问题。(2)某些项目要使用多种可视化图形工具来编写。

对于难题(1)该发明解决方案如下：

初次进入某个模块时，视为发生了一个根级别动作。在该模块下进行的其它操作，视为根级别动作的子动作。每个动作(包括根级别动作)都是一个对象，其中包括接口url、动作行为标题、动作文字说明、动作识别标签、动作的PlantUML代码块。每个根级别动作为树形数据结构T第二层级的键值对key值，其对应所有子动作是该键值对的value值，value值是一个对象。如果该模块的二级页面具有子页面的动作，则该子页面动作为二级动作，其下子动作为三级动作，以此类推，树形数据结构T层级结构也逐步加深。

通过这种结构存储的方式，可以兼容用户错乱点击和重复多次点击的操作情况。用户错乱点击的时候，只是记录片段行为，该片段行为通过各个模块的根级别动作串联，通过错乱点击同样可以逐渐形成完整的模块结构，进而生成整体文档。当用户重复多次点击的时候，每个动作都会通过键值对的key值判断该动作是否发生过，若发生过，则不会重复写入。

T使用Map嵌套结构来存储，层级定义如下：

用户权限标识为数据第一层级(根层级)，所有主模块操作为第二层级(根级别动作)，主模块的第一层子页面操作为第三层级，以此类推。

对于难题(2)该发明解决方案如下：

生成的树形数据结构T编译成Markdown和PlantUML、Graphviz等可视化图形工具可识别的数据形式，转化成项目流程文档。