技術領域

本發明涉及一種用戶界面操作手冊編寫技術領域，具體地說是一種所見即所得的用戶界面操作手冊編寫及生成方法。

背景技術

在MDD(模型驅動開發)模式下，用戶圖形界面的定義被描述為一個模型描述文件，它通常采用XML文檔結構，它的結構一般描述為界面布局容器和具體界面組成元素之間的分層嵌套的結構。基于MDD(模型驅動開發)描述的用戶圖形界面模型，是由界面組成元素構成，其包括容器類界面元素和具體界面元素兩類。具體界面元素一般是一個圖形控件或具有特定含義的標簽(例如Html的標記標簽<input/>等)。每一種界面組成元素，在MDD中對應一個模型元素類型(XML)。

例如一個圖形界面帶有工具欄、布局容器及輸入控件，那么其描述結構如下所示：

然后在運行時，通過代碼生成器生成源代碼編譯或通過解析程序對模型描述文件解析的方式，最終形成運行時用戶可操作的用戶圖形界面程序。

在軟件交付給用戶使用之前，需要編寫用戶界面操作手冊。這個過程一般是由相關文檔編寫人員，依照軟件操作實現，手工編輯文字和插圖來實現，這個過程往往比較繁瑣和低效，并且文檔質量參差不齊；并且當軟件實現修改后，用戶界面操作手冊也許有手工修改文檔，甚至因為未及時編寫文檔，導致用戶界面操作手冊和軟件實現脫節。

發明內容

本發明的技術任務是針對以上不足之處，提供一種所見即所得的用戶界面操作手冊編寫及生成方法，來解決用戶界面操作手冊和軟件實現脫節的問題。

本發明解決其技術問題所采用的技術方案是：

一種所見即所得的用戶界面操作手冊編寫及生成方法，包括如下步驟：

(1)、設置用戶圖形界面的用戶界面操作手冊相關的屬性描述：用戶界面操作手冊的屬性描述與用戶圖形界面模型中的模型元素類型對應，為每一個模型元素類型添加用戶界面操作手冊屬性描述；該屬性描述是一個屬性定義的集合；

(2)、設置用戶界面操作手冊的文檔模版：基于模版引擎技術，將用戶圖形界面模型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性進行合成，并作為模版的變量輸入，即根據具體的用戶界面操作手冊的文檔格式生成具體的用戶界面操作手冊的文檔模版；

(3)、錄入用戶界面操作手冊的相關屬性信息：提供一個用于編輯用戶界面操作手冊屬性的編輯工具，加載指定的用戶圖形界面模型XML和用戶界面操作手冊屬性定義，用于錄入或編輯相應的用戶界面操作手冊屬性；

(4)、生成用戶界面操作手冊的實現步驟：提供一個用于生成具體用戶界面操作手冊的工具，該工具根據用戶選擇的用戶圖形界面模型，加載該用戶圖形界面模型XML及步驟(3)描述的用戶界面操作手冊屬性列表值，依據步驟(2)描述的合成關系，調用模版引擎，生成相應的用戶界面操作手冊文檔。

步驟(1)中，屬性定義包含以下具體信息：屬性標識、屬性顯示名稱、屬性編輯方式、是否必填。

步驟(1)中，屬性編輯方式分為兩種：簡單文本編輯、富文本編輯。富文本編輯指的是可支持字體、顏色、縮進等。

步驟(2)中，用戶圖形界面模型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性的合成，是在每個界面組成元素的XML描述中，追加用戶界面操作手冊屬性對應的XML屬性，其屬性名為步驟(1)中定義的用戶界面操作手冊屬性的屬性標識。其具體XML表述為：

<界面組成元素界面組成元素屬性1＝"...",...,界面組成元素屬性n＝"...",用戶界面操作手冊屬性標識1＝"...",...,用戶界面操作手冊屬性標識n＝"..."/>。

步驟(3)中，當具體選擇一個界面組成元素時，工具顯示該界面組成元素對應的模型元素類型的用戶界面操作手冊屬性列表，并提供用戶界面操作手冊屬性列表值的編輯及存儲。

步驟(3)中，用戶界面操作手冊屬性值的存儲包含以下信息項：用戶圖形界面模型標識、界面組成元素標識、用戶界面操作手冊屬性標識、屬性值。

本發明的一種所見即所得的用戶界面操作手冊編寫及生成方法和現有技術相比，具有以下有益效果：

1、應用模版引擎技術，其基本工作原理為在一段文本中通過特殊標記，插入數據變量及程序流程控制的程序語句；通過輸入不同的數據，同一個模版可以生成不同的文本文檔；

2、能夠根據用戶圖形界面，所見即所得的即時編輯用戶界面操作手冊相關內容，并能夠自動生成或同步用戶界面操作手冊；