一種所見即所得的用戶界面操作手冊編寫及生成方法
【技術(shù)領(lǐng)域】
[0001] 本發(fā)明涉及一種用戶界面操作手冊編寫技術(shù)領(lǐng)域，具體地說是一種所見即所得的 用戶界面操作手冊編寫及生成方法。
【背景技術(shù)】
[0002] 在MDD (模型驅(qū)動開發(fā)）模式下，用戶圖形界面的定義被描述為一個模型描述文 件，它通常采用XML文檔結(jié)構(gòu)，它的結(jié)構(gòu)一般描述為界面布局容器和具體界面組成元素之 間的分層嵌套的結(jié)構(gòu)?；贛DD(模型驅(qū)動開發(fā)）描述的用戶圖形界面模型，是由界面組成 元素構(gòu)成，其包括容器類界面元素和具體界面元素兩類。具體界面元素一般是一個圖形控 件或具有特定含義的標簽（例如Html的標記標簽〈input/〉等）。每一種界面組成元素，在 MDD中對應(yīng)一個模型元素類型（XML)。
[0003] 例如一個圖形界面帶有工具欄、布局容器及輸入控件，那么其描述結(jié)構(gòu)如下所 示：
[0004]
[0005]
[0006] 然后在運行時，通過代碼生成器生成源代碼編譯或通過解析程序?qū)δＰ兔枋鑫募?解析的方式，最終形成運行時用戶可操作的用戶圖形界面程序。
[0007] 在軟件交付給用戶使用之前，需要編寫用戶界面操作手冊。這個過程一般是由相 關(guān)文檔編寫人員，依照軟件操作實現(xiàn)，手工編輯文字和插圖來實現(xiàn)，這個過程往往比較繁瑣 和低效，并且文檔質(zhì)量參差不齊；并且當軟件實現(xiàn)修改后，用戶界面操作手冊也許有手工修 改文檔，甚至因為未及時編寫文檔，導(dǎo)致用戶界面操作手冊和軟件實現(xiàn)脫節(jié)。

【發(fā)明內(nèi)容】

[0008] 本發(fā)明的技術(shù)任務(wù)是針對以上不足之處，提供一種一種所見即所得的用戶界面操 作手冊編寫及生成方法，來解決用戶界面操作手冊和軟件實現(xiàn)脫節(jié)的問題。
[0009] 本發(fā)明解決其技術(shù)問題所采用的技術(shù)方案是：
[0010] -種所見即所得的用戶界面操作手冊編寫及生成方法，包括如下步驟：
[0011] (1)、設(shè)置用戶圖形界面的用戶界面操作手冊相關(guān)的屬性描述：用戶界面操作手冊 的屬性描述與用戶圖形界面模型中的模型元素類型對應(yīng)，為每一個模型元素類型添加用戶 界面操作手冊屬性描述；該屬性描述是一個屬性定義的集合；
[0012] (2)、設(shè)置用戶界面操作手冊的文檔模版：基于模版引擎技術(shù)，將用戶圖形界面模 型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性進行合成，并作為模版的變量 輸入，即根據(jù)具體的用戶界面操作手冊的文檔格式生成具體的用戶界面操作手冊的文檔模 版；
[0013] (3)、錄入用戶界面操作手冊的相關(guān)屬性信息：提供一個用于編輯用戶界面操作手 冊屬性的編輯工具，加載指定的用戶圖形界面模型XML和用戶界面操作手冊屬性定義，用 于錄入或編輯相應(yīng)的用戶界面操作手冊屬性；
[0014] (4)、生成用戶界面操作手冊的實現(xiàn)步驟：提供一個用于生成具體用戶界面操作手 冊的工具，該工具根據(jù)用戶選擇的用戶圖形界面模型，加載該用戶圖形界面模型XML及步 驟（3)描述的用戶界面操作手冊屬性列表值，依據(jù)步驟（2)描述的合成關(guān)系，調(diào)用模版引 擎，生成相應(yīng)的用戶界面操作手冊文檔。
[0015] 步驟（1)中，屬性定義包含以下具體信息：屬性標識、屬性顯示名稱、屬性編輯方 式、是否必填。
[0016] 步驟（1)中，屬性編輯方式分為兩種：簡單文本編輯、富文本編輯。富文本編輯指 的是可支持字體、顏色、縮進等。
[0017] 步驟（2)中，用戶圖形界面模型的XML文檔及模型元素類型擴展的用戶界面操作 手冊屬性的合成，是在每個界面組成元素的XML描述中，追加用戶界面操作手冊屬性對應(yīng) 的XML屬性，其屬性名為步驟（1)中定義的用戶界面操作手冊屬性的屬性標識。其具體XML 表述為：
[0018] 〈界面組成元素界面組成元素屬性1 = 界面組成元素屬性η ="... 〃， 用戶界面操作手冊屬性標識1 = 用戶界面操作手冊屬性標識η =
[0019] 步驟（3)中，當具體選擇一個界面組成元素時，工具顯示該界面組成元素對應(yīng)的 模型元素類型的用戶界面操作手冊屬性列表，并提供用戶界面操作手冊屬性列表值的編輯 及存儲。
[0020] 步驟（3)中，用戶界面操作手冊屬性值的存儲包含以下信息項：用戶圖形界面模 型標識、界面組成元素標識、用戶界面操作手冊屬性標識、屬性值。
[0021] 本發(fā)明的一種所見即所得的用戶界面操作手冊編寫及生成方法和現(xiàn)有技術(shù)相比， 具有以下有益效果：
[0022] 1、應(yīng)用模版引擎技術(shù)，其基本工作原理為在一段文本中通過特殊標記，插入數(shù)據(jù) 變量及程序流程控制的程序語句；通過輸入不同的數(shù)據(jù)，同一個模版可以生成不同的文本 文檔；
[0023] 2、能夠根據(jù)用戶圖形界面，所見即所得的即時編輯用戶界面操作手冊相關(guān)內(nèi)容， 并能夠自動生成或同步用戶界面操作手冊；
[0024] 3、用戶可靈活的設(shè)置待生成的用戶界面操作手冊模版，通過用戶界面操作手冊屬 性編輯工具，可直觀、快速的編輯用戶界面操作手冊內(nèi)容，從而一次性的批量生成用戶界面 操作手冊；
[0025] 4、當部分用戶圖形界面調(diào)整后，可快速的編輯和同步用戶界面操作手冊；降低了 用戶界面操作手冊編寫及維護的繁瑣度，提高了用戶界面操作手冊編寫的效率及實時性， 并有利于用戶界面操作手冊格式的一致性。
【附圖說明】
[0026] 下面結(jié)合附圖對本發(fā)明進一步說明。
[0027] 附圖1為【背景技術(shù)】中描述的用戶圖形界面模型構(gòu)成示意圖；
[0028] 附圖2為一種所見即所得的用戶界面操作手冊編寫及生成方法的用戶界面操作 手冊屬性與模型元素類型關(guān)系結(jié)構(gòu)示意圖；
[0029] 附圖3為一種所見即所得的用戶界面操作手冊編寫及生成方法的工作原理圖。
【具體實施方式】
[0030] 下面結(jié)合附圖和具體實施例對本發(fā)明作進一步說明。
[0031] 實施例1 :
[0032] 本發(fā)明的一種所見即所得的用戶界面操作手冊編寫及生成方法，包括如下步驟：
[0033] (1)、設(shè)置用戶圖形界面的用戶界面操作手冊相關(guān)的屬性描述：用戶界面操作手冊 的屬性描述與用戶圖形界面模型中的模型元素類型對應(yīng)，為每一個模型元素類型添加用戶 界面操作手冊屬性描述；該屬性描述是一個屬性定義的集合；
[0034] (2)、設(shè)置用戶界面操作手冊的文檔模版：基于模版引擎技術(shù)，將用戶圖形界面模 型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性進行合成，并作為模版的變量 輸入，即根據(jù)具體的用戶界面操作手冊的文檔格式生成具體的用戶界面操作手冊的文檔模 版；
[0035] (3)、錄入用戶界面操作手冊的相關(guān)屬性信息：提供一個用于編輯用戶界面操作手 冊屬性的編輯工具，加載指定的用戶圖形界面模型XML和用戶界面操作手冊屬性定義，用 于錄入或編輯相應(yīng)的用戶界面操作手冊屬性；
[0036] (4)、生成用戶界面操作手冊的實現(xiàn)步驟：提供一個用于生成具體用戶界面操作手 冊的工具，該工具根據(jù)用戶選擇的用戶圖形界面模型，加載該用戶圖形界面模型XML及步 驟（3)描述的用戶界面操作手冊屬性列表值，依據(jù)步驟（2)描述的合成關(guān)系，調(diào)用模版引 擎，生成相應(yīng)的用戶界面操作手冊文檔。
[0037] 實施例2 :
[0038] 本發(fā)明的一種所見即所得的用戶界面操作手冊編寫及生成方法，包括如下步驟：
[0039] (1)、設(shè)置用戶圖形界面的用戶界面操作手冊相關(guān)的屬性描述：用戶界面操作手 冊的屬性描述與用戶圖形界面模型中的模型元素類型對應(yīng)，為每一個模型元素類型添加用 戶界面操作手冊屬性描述；該屬性描述是一個屬性定義的集合；屬性定義包含以下具體信 息：屬性標識、屬性顯示名稱、屬性編輯方式、是否必填；屬性編輯方式分為兩種：簡單文本 編輯、富文本編輯。富文本編輯指的是可支持字體、顏色、縮進等；
[0040] (2)、設(shè)置用戶界面操作手冊的文檔模版：基于模版引擎技術(shù)，將用戶圖形界面模 型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性進行合成，并作為模版的變量 輸入，即根據(jù)具體的用戶界面操作手冊的文檔格式生成具體的用戶界面操作手冊的文檔模 版；
[0041] 用戶圖形界面模型的XML文檔及模型元素類型擴展的用戶界面操作手冊屬性的 合成，是在每個界面組成元素的XML描述中，追加用戶界面操作手冊屬性對應(yīng)的XML屬性， 其屬性名為步驟（1)中定義的用