CN1869973A

CN1869973A - 生成文档的方法和系统

Info

Publication number: CN1869973A
Application number: CNA2005100730306A
Authority: CN
Inventors: 叶盛; 王海川; 张冠群; 黄鹤远
Original assignee: International Business Machines Corp
Current assignee: International Business Machines Corp
Priority date: 2005-05-27
Filing date: 2005-05-27
Publication date: 2006-11-29
Also published as: US20090037801A1

Abstract

本发明公开了一种生成文档的方法，该方法包括步骤：记录对一个信息技术系统的操作的信息；将所述信息放入一个文档模型中；通过映射所述文档模型中的信息，生成一个文档。本发明还公开了一种生成文档的系统。根据本发明，用户手册的制作者只需要操作一次IT系统，就可以自动生成该IT系统的用户手册，从而使得用户手册的制作者不再需要进行重复性的、乏味的工作，因此能节约大量的制作时间。并且，用户手册的风格可以由用户定义。根据本发明，还可以很容易地生成不同语言版本的用户手册。生成的用户手册具有标准的格式。

Description

生成文档的方法和系统

技术领域

本发明涉及信息技术领域，尤其涉及一种生成文档的方法和系统。

背景技术

目前，信息技术(IT)系统越来越复杂，从而这些IT系统的用户手册也越来越复杂，并且对于用户来说，用户手册比以前变得更加重要。通常情况下，用户手册是描述怎样使用IT系统的文档，它帮助用户理解IT系统的功能和界面等。一般地，用户手册介绍一个IT系统的总体功能和特征，并分步给出操作指导，使用户比较容易地掌握该IT系统的操作。

目前，为了制作一个IT系统的用户手册，制作者必须能够熟练地使用该IT系统，并记录下使用该IT系统的过程中的操作过程。该操作过程通常包括用户输入和系统反馈，例如鼠标或键盘输入，画面和声音输出等。

目前已经有用来捕获可以用作视频演示的画面流的工具，也有用来记录用户的输入操作的工具。但是这些工具对于编写用户手册远远不够。在制作用户手册时，制作者需要写下他的操作并复制画面，然后将这些复制的画面粘贴到用户手册文档中，并补充一些说明。例如，典型的用户输入描述为键入“XXX”并点击“OK”按钮。可以看出，创建用户手册的工作包含许多重复性的操作。

因此，需要一种生成文档的方法和系统，从而可以使得用户手册的制作者不再需要进行重复性的、乏味的工作，并因此节约大量的制作时间。

发明内容

本发明的一个目的是提供一种生成文档的方法和系统，其能减少该文档的制作时间。

为了实现上述目的，本发明提出了一种生成文档的方法，该方法包括步骤：记录对一个信息技术系统的操作的信息；将所述信息放入一个文档模型中；通过映射所述文档模型中的信息，生成一个文档。

优选地，所述信息包括对所述信息技术系统进行操作时在操作系统中发送的消息。

优选地，所述信息包括至少一个操作前后的画面。

优选地，所述信息包括各个操作的先后次序。

优选地，通过将所述信息映射到一个文档模板中的相应部分从而生成所述文档。

优选地，还包括接受对所述文档模型中的内容的修改的步骤。

优选地，所述文档为所述信息技术系统的用户手册。

本发明还提出了一种生成文档的系统，包括：记录模块，用于记录对一个信息技术系统的操作的信息；生成模块，用于通过映射放入在一个文档模型中的所述信息，生成一个文档。

根据本发明，用户手册的制作者只需要操作一次IT系统，就可以自动生成该IT系统的用户手册，从而使得用户手册的制作者不再需要进行重复性的、乏味的工作，例如，写下他的操作，复制画面，将这些画面粘贴到用户手册文档，并补充一些说明等操作，因此能节约大量的制作时间。并且，用户手册的风格可以由用户定义。根据本发明，还可以很容易地生成不同语言版本的用户手册。生成的用户手册具有标准的格式。制作者可以在现有的编辑器中容易地编辑生成的用户手册。

通过以下结合附图对本发明优选实施方式的描述，本发明的其他特点、目的和效果将变得更加清楚和易于理解。

附图说明

下面将参考附图来描述本发明的优选实施方式，其中：

图1是一个示意性框图，示出了一个计算机系统，该计算机系统能够实现本发明的一个实施方式；

图2是一个用户手册中的一页的示例；

图3是根据本发明的一个实施方式的生成用户手册的流程图；

图4是制作者操作一个IT系统时出现的一个画面的示例；

图5是一个文档模型的示例；

图6是根据本发明的一个实施方式，将一个文档模型中的内容映射到一个用户手册模板从而生成用户手册的示意图。

在所有的上述附图中，相同的标号表示具有相同、相似或相应的特征和功能。

具体实施方式

这里，以自动生成一个I T系统的用户手册为例，例如计算机软件操作的用户手册，数字化设备操作的用户手册等等，描述本发明的优选实施方式。但是，本领域的普通技术人员应当理解，本发明不局限于此，本发明同样适用于自动生成其它类型的文档，例如网页等。

在本申请中，术语“可执行代码”意在包括任何类型的计算机指令和计算机可执行代码，它们可以位于存储设备内和/或在系统总线或网络内以电信号传输。与可执行代码等同的模块可以是，例如，包括一个或多个计算机指令的物理或逻辑块，这些计算机指令可以以对象、过程或功能进行组织。并且，包括不同指令的模块的可执行代码不需要物理地存储在一起，它们可以存储在不同的位置。当这些可执行代码逻辑地联合起来时，组成该模块，并实现该模块的目的或功能。实际上，可执行代码可以是单条指令，或多条指令，并可以分布在多个不同的代码段、不同的程序、以及跨越多个存储设备。

同样地，可以在模块中识别操作数，并且，可以以任何合适的形式体现操作数，以及操作数可以包括在任何合适的数据结构中。

图1是一个示意性框图，示出了一个计算机系统10，其中，按照本发明的模块和操作数可以位于网络14中的一个或者多个计算站12中。

典型地，计算站12可以包括处理器或CPU 16。CPU 16可连接到一个或者多个存储设备18。图1中所示的存储设备18包括非易失存储设备20，例如硬盘或光盘，只读存储设备(ROM)22和易失、随机存储设备(RAM)24。

计算站12还可以包括一个或多个输入设备26，例如鼠标或者键盘等，用于从用户或其它设备接收输入。同样地，还可以包括一个或多个输出设备28，例如显示器等。还可以包括例如网络接口卡等之类的网络端口30，用于通过网络14连接到其它设备。当计算站12与网络14很远时，该网络端口30可以包括调制解调器，并通过本地接入线路，例如电话线路，连接到网络14。

在任何一个计算站12中，具有可连接到CPU 16、存储设备18、输入设备26、输出设备28、网络端口30以及一个或多个额外端口34的系统总线32。系统总线32和网络骨干36可以认为是数据承运者。同样地，系统总线32和网络骨干36可以采用各种各样的配置，例如，可以采用电线、电缆、光缆、可见光无线通信、红外光通信等等。

一般来说，网络14可以包括单个局域网(LAN)、广域网(WAN)、内联网等。各个计算站12通过各种通信能力和逻辑能力经由网络骨干36与其它计算站12通信。网络14还可以包括应用服务器42，和/或其它资源或外围设备44，例如打印机和扫描仪等。

在网络14中，可以使用各种不同的通信协议，例如ISO/OSI、IPX以及TCP/IP等。其它网络可以通过例如互联网40和/或路由器38，与网络14通信。

图2是一个用户手册的其中一页的示例。

如图2所示，用户手册200包括一个描述部分201。在描述部分201中，总体描述该页的目的，例如该页用户手册旨在使一个IT系统的用户学习怎样创建类图。用户手册200还可以包括一个任务描述部分202。在任务描述部分202中，说明该页用户手册的任务，例如是创建一个Java项目。用户手册200还可以包括一个步骤部分203，在该步骤部分203，依操作顺序描述创建一个任务所要操作的步骤。反映这些步骤的内容一般包括画面和动作提示，其中该画面是用户进行操作的画面。例如，对于创建一个Java项目来说，第一步为在显示的画面的菜单中选择文件>新>项目；第二步为在随后显示的画面中选择Java>Java项目，并点击下一步按钮；等等。

图3是根据本发明的一个实施方式的生成用户手册的流程图。

下面，参照图1所示的计算机系统描述图3所示的流程图。

假设一个IT系统装载在图1所示的计算机系统中。当该IT系统的用户手册的制作者开始制作用户手册时，可通过输入设备26启动一个记录模块(步骤S301)。该记录模块可以位于存储设备18中。

接下来，在步骤S302，该记录模块记录该制作者对该IT系统的操作并捕获操作之前显示的画面以及操作之后形成的画面。此外，该记录模块还记录各个操作的先后次序等信息。

当然，根据需要，该记录模块还可以记录其它信息。所记录的信息的种类和数量不构成对本发明的限制。

当制作者通过操作输入设备26，例如鼠标的移动或者点击，键盘的敲击等，操作该IT系统时，将会向操作系统发送一些消息。例如，当制作者创建一个新的Java项目时，将会在输出设备28上显示一个对话框向导，并且，制作者通过输入设备26在该向导上进行两步操作。第一步，点击在该对话框中的“Java项目”，第二步，点击“下一步”按钮，如图4所示。

当该制作者进行如上操作时，该记录模块可以从操作系统得到两个消息。通过分析这两个消息，可以得出第一个操作的动作类型是“选择”，并且动作目标是“Java项目”项；第二个操作的动作类型是“点击”，并且动作目标是“下一步”按钮。并且，记录模块可以记录这两个操作的先后顺序，即流脚本，例如选择“Java项目”在前，点击“下一步”按钮在后。

然后，在步骤S303，将记录在该记录模块中的上述信息，包括制作者的操作、操作前后的画面以及这些操作的先后次序等，置于一个文档模型中，并在输出设备28上显示该文档模型，以便进行下一步的处理。

应当理解，该文档模型可以由记录模块生成，也可以由下面将描述的生成模块生成。

图5是一个文档模型的示例。如图5所示，该文档模型包括名称、版本、制作者、标题、一些描述以及评论等等。该文档模型可以包括多个章节(图中只示出了一个)，每个章节包括名称、一些描述以及画面等等。并且，每个章节还可以包括多个动作(图中只示出了一个)，其中动作包括动作类型以及动作目标等等。动作类型包括点击、双击、右击、选择、打开、拖拉、移动以及输入信息等等。动作目标包括窗口、对话框、菜单、按钮、输入域、列表框、组合框、滚动条以及滑动块等等。

接下来，在步骤S304，接受对文档模型中的信息的修改。

由于要生成可读性很好的用户手册，上述文档模型中的内容有可能不够完善，因此制作者可以通过输入设备26修改该文档模型中的内容。例如，增加相关的描述、增加名称和标题、修改动作类型和动作目标，以及修改其它信息等等。

接下来，在步骤S305，生成用户手册。

当制作者修改完成后，由一个生成模块，该生成模块可以位于存储设备18中，通过将修改后的文档模型，映射到一个用户手册模板，从而生成对应于上述操作的用户手册。例如，如图6所示，将文档模型中的标题映射到用户手册模板的描述部分，将章节中的画面，以及各个动作的动作类型和动作目标等等信息映射到步骤部分。

通过将修改后的文档模型映射到不同的用户手册模板，可以生成不同风格，不同语言的用户手册，例如基于书签格式的英文用户手册，或者基于网页格式的中文用户手册。

这样生成的用户手册包括用户手册的主框架。并且，制作者可以在现有的编辑器中编辑该生成的用户手册，以得到更完善的用户手册的最终版本。

应当理解，对本领域的技术人员来说，可以通过各种各样的方法，例如基于Java语言的代码，来实现上述的记录模块和生成模块。

当然，本领域的技术人员还应当理解，包括上述记录模块和生成模块的生成文档的系统可以位于存储设备18中，也可以在系统总线或网络内以电信号传输。

不脱离本发明的构思和范围可以做出许多其它改变和改型。应当理解，本发明不限于特定的实施方式，本发明的范围由所附权利要求限定。

Claims

1.一种生成文档的方法，包括步骤：

(a)记录对一个信息技术系统的操作的信息；

(b)将所述信息放入一个文档模型中；以及

(c)通过映射所述文档模型中的信息，生成一个文档。

2.根据权利要求1所述的方法，其中所述信息包括对所述信息技术系统进行操作时在操作系统中发送的消息。

3.根据权利要求1所述的方法，其中所述信息包括至少一个操作前后的画面。

4.根据权利要求1所述的方法，其中所述信息包括各个操作的先后次序。

5.根据权利要求1所述的方法，其中在步骤(c)，通过将所述文档模型中的信息映射到一个文档模板中的相应部分从而生成所述文档。

6.根据权利要求1所述的方法，其中在步骤(b)和步骤(c)之间，还包括接受对所述文档模型中的信息的修改的步骤。

7.根据权利要求1-6中任一项所述的方法，其中所述文档为所述信息技术系统的用户手册。

8.一种生成文档的系统，包括：

记录模块，用于记录对一个信息技术系统的操作的信息；

生成模块，用于通过映射放入在一个文档模型中的所述信息，生成一个文档。

9.根据权利要求8所述的系统，其中所述信息包括对所述信息技术系统进行操作时在操作系统中发送的消息。

10.根据权利要求8所述的系统，其中所述信息包括至少一个操作前后的画面。

11.根据权利要求8所述的系统，其中所述信息包括各个操作的先后次序。

12.根据权利要求8所述的系统，其中所述文档模型由所述记录模块生成。

13.根据权利要求8所述的系统，其中所述文档模型由所述生成模块生成。

14.根据权利要求8所述的系统，其中所述生成模块通过将所述文档模型中的信息映射到一个文档模板中的相应部分从而生成所述文档。

15.根据权利要求8所述的系统，其中所述文档模型中的信息根据需要被修改。

16.根据权利要求8-15中任一项所述的系统，其中所述文档为所述信息技术系统的用户手册。