[發明專利]一種自動生成項目流程文檔的方法及系統

在審

• 申請號: 202010941989.1
• 申請日: 2020-09-09
• 公開（公告）號: CN112068841A
• 公開（公告）日: 2020-12-11
• 發明（設計）人: 宋金澤;鄭姣;李星星
• 申請（專利權）人: 上海萬向區塊鏈股份公司
• 主分類號: G06F8/41
• 分類號: G06F8/41;G06F8/40
• 代理公司: 上海段和段律師事務所 31334
• 代理人: 李佳俊;郭國中

本發明提供了一種自動生成項目流程文檔的方法及系統，包括：步驟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等可視化圖形工具可識別的數據形式，轉化成項目流程文檔。