一种所见即所得的用户界面操作手册编写及生成方法

摘要

本发明公开了一种所见即所得的用户界面操作手册编写及生成方法，属于用户界面操作手册编写技术领域，本发明解决用户界面操作手册和软件实现脱节的问题。技术方案步骤为：（1）、设置用户图形界面的用户界面操作手册相关的属性描述；（2）、设置用户界面操作手册的文档模版：将用户图形界面模型的XML文档及模型元素类型扩展的用户界面操作手册属性进行合成；（3）、录入用户界面操作手册的相关属性信息：提供一个用于编辑用户界面操作手册属性的编辑工具；（4）、生成用户界面操作手册的实现步骤：加载该用户图形界面模型XML及用户界面操作手册属性列表值，生成相应的用户界面操作手册文档。

说明书

技术领域

本发明涉及一种用户界面操作手册编写技术领域，具体地说是一种所见即所得的用户界 面操作手册编写及生成方法。

背景技术

在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、能够根据用户图形界面，所见即所得的即时编辑用户界面操作手册相关内容，并能 够自动生成或同步用户界面操作手册；

3、用户可灵活的设置待生成的用户界面操作手册模版，通过用户界面操作手册属性编 辑工具，可直观、快速的编辑用户界面操作手册内容，从而一次性的批量生成用户界面操作 手册；

4、当部分用户图形界面调整后，可快速的编辑和同步用户界面操作手册；降低了用户 界面操作手册编写及维护的繁琐度，提高了用户界面操作手册编写的效率及实时性，并有利 于用户界面操作手册格式的一致性。

附图说明

下面结合附图对本发明进一步说明。

附图1为背景技术中描述的用户图形界面模型构成示意图；

附图2为一种所见即所得的用户界面操作手册编写及生成方法的用户界面操作手册属性 与模型元素类型关系结构示意图；

附图3为一种所见即所得的用户界面操作手册编写及生成方法的工作原理图。

具体实施方式

下面结合附图和具体实施例对本发明作进一步说明。

实施例1：

本发明的一种所见即所得的用户界面操作手册编写及生成方法，包括如下步骤：

(1)、设置用户图形界面的用户界面操作手册相关的属性描述：用户界面操作手册的属 性描述与用户图形界面模型中的模型元素类型对应，为每一个模型元素类型添加用户界面操 作手册属性描述；该属性描述是一个属性定义的集合；

(2)、设置用户界面操作手册的文档模版：基于模版引擎技术，将用户图形界面模型的 XML文档及模型元素类型扩展的用户界面操作手册属性进行合成，并作为模版的变量输入， 即根据具体的用户界面操作手册的文档格式生成具体的用户界面操作手册的文档模版；

(3)、录入用户界面操作手册的相关属性信息：提供一个用于编辑用户界面操作手册属 性的编辑工具，加载指定的用户图形界面模型XML和用户界面操作手册属性定义，用于录入 或编辑相应的用户界面操作手册属性；

(4)、生成用户界面操作手册的实现步骤：提供一个用于生成具体用户界面操作手册的 工具，该工具根据用户选择的用户图形界面模型，加载该用户图形界面模型XML及步骤(3) 描述的用户界面操作手册属性列表值，依据步骤(2)描述的合成关系，调用模版引擎，生成 相应的用户界面操作手册文档。

实施例2：

本发明的一种所见即所得的用户界面操作手册编写及生成方法，包括如下步骤：

(1)、设置用户图形界面的用户界面操作手册相关的属性描述：用户界面操作手册的属 性描述与用户图形界面模型中的模型元素类型对应，为每一个模型元素类型添加用户界面操 作手册属性描述；该属性描述是一个属性定义的集合；属性定义包含以下具体信息：属性标 识、属性显示名称、属性编辑方式、是否必填；属性编辑方式分为两种：简单文本编辑、富 文本编辑。富文本编辑指的是可支持字体、颜色、缩进等；

(2)、设置用户界面操作手册的文档模版：基于模版引擎技术，将用户图形界面模型的 XML文档及模型元素类型扩展的用户界面操作手册属性进行合成，并作为模版的变量输入， 即根据具体的用户界面操作手册的文档格式生成具体的用户界面操作手册的文档模版；

用户图形界面模型的XML文档及模型元素类型扩展的用户界面操作手册属性的合成，是 在每个界面组成元素的XML描述中，追加用户界面操作手册属性对应的XML属性，其属性名 为步骤(1)中定义的用户界面操作手册属性的属性标识；

其具体XML表述为：

<界面组成元素界面组成元素属性1＝"...",...,界面组成元素属性n＝"...",用户界 面操作手册属性标识1＝"...",...,用户界面操作手册属性标识n＝"..."/>；

(3)、录入用户界面操作手册的相关属性信息：提供一个用于编辑用户界面操作手册属 性的编辑工具，加载指定的用户图形界面模型XML和用户界面操作手册属性定义，用于录入 或编辑相应的用户界面操作手册属性；当具体选择一个界面组成元素时，工具显示该界面组 成元素对应的模型元素类型的用户界面操作手册属性列表，并提供用户界面操作手册属性列 表值的编辑及存储；用户界面操作手册属性值的存储包含以下信息项：用户图形界面模型标 识、界面组成元素标识、用户界面操作手册属性标识、属性值；

(4)、生成用户界面操作手册的实现步骤：提供一个用于生成具体用户界面操作手册的 工具，该工具根据用户选择的用户图形界面模型，加载该用户图形界面模型XML及步骤(3) 描述的用户界面操作手册属性列表值，依据步骤(2)描述的合成关系，调用模版引擎，生成 相应的用户界面操作手册文档。

实施例3：

本发明的一种所见即所得的用户界面操作手册编写及生成方法，包括如下步骤：

(1)、设置用户图形界面的用户界面操作手册相关的属性描述：用户界面操作手册的属 性描述与用户图形界面模型中的模型元素类型对应，为每一个模型元素类型添加用户界面操 作手册属性描述；该属性描述是一个属性定义的集合；

(2)、设置用户界面操作手册的文档模版：基于模版引擎技术，将用户图形界面模型的 XML文档及模型元素类型扩展的用户界面操作手册属性进行合成，并作为模版的变量输入， 即根据具体的用户界面操作手册的文档格式生成具体的用户界面操作手册的文档模版；

(3)、录入用户界面操作手册的相关属性信息：提供一个用于编辑用户界面操作手册属 性的编辑工具，加载指定的用户图形界面模型XML和用户界面操作手册属性定义，用于录入 或编辑相应的用户界面操作手册属性；

(4)、生成用户界面操作手册的实现步骤：提供一个用于生成具体用户界面操作手册的 工具，该工具根据用户选择的用户图形界面模型，加载该用户图形界面模型XML及步骤(3) 描述的用户界面操作手册属性列表值，依据步骤(2)描述的合成关系，调用模版引擎，生成 相应的用户界面操作手册文档。

如下以某系统的采购订单基本信息界面为例，对上述四个步骤进行说明。基于步骤(1)， 该界面主要由工具栏按钮和输入控件两类模型元素类型组成，其对应的用户界面操作手册的 属性如表1所示：

模型元素类型 属性标识 显示名称 编辑方式 是否必填 工具栏按钮 functionDesc 功能描述 富文本编辑 是 工具栏按钮 noticeInfo 注意事项 富文本编辑 否 输入控件 fieldDesc 字段含义 富文本编辑 是 输入控件 inputRule 输入规则说明 富文本编辑 是

表1

基于步骤(2)，定义文档模板的伪代码片段如下：

操作按钮说明：

输入字段说明：

基于步骤(3)，使用用户界面操作手册属性编辑工具原型，用户可所见即所得的快速录 入相应的用户界面操作手册相关属性信息。录入的描述信息大致如表2所示：

表2

基于步骤(4)，在生成时，对用户图形界面模型和用户界面操作手册属性进行合并，合 并后的XML片段，以采购订单基本信息的新建按钮为例，内容如下：

<ToolbarButtionItemid＝"btnCreate"text＝"新建(&C)",...,functionDesc＝"创建 一个新的采购订单",noticeInfo＝"如果您权限不足，系统会给予提示。"/>。

将合成后的文档XML和实施例步骤二定义的用户界面操作手册文档模版，调用模版引擎， 可生成最终的用户界面操作手册文档，示例如下：

操作按钮说明：

新增按钮：创建一个新的采购订单。

注意事项：如果您权限不足，系统会给予提示。

…

输入字段说明：

…

金额字段：采购订单的总价合计

输入规则说明：货币类型，不允许输入负数。

通过上面具体实施方式，所述技术领域的技术人员可容易的实现本发明。但是应当理解， 本发明并不限于上述的具体实施方式。在公开的实施方式的基础上，所述技术领域的技术人 员可任意组合不同的技术特征，从而实现不同的技术方案。

除说明书所述的技术特征外，均为本专业技术人员的已知技术。