CN1959681A - 生成技术手册的方法和系统 - Google Patents

Abstract

该系统一方面包括：一数据仓库(16)，其包含信息条目，每个信息条目至少一个机器的至少一个技术元素元件，在数据仓库(16)中每个信息条目与其涉及的技术元素关联，以及，另一方面包括：装置(44E)，用于生成由包括逻辑部分的手册结构所定义的手册模板(50)；装置(44E)，用于在手册模板结构(50)的逻辑部分中插入到从数据仓库(16)的信息中所选择的信息条目的至少一个链接，以及装置(46C)，用于控制编辑补充有链接的手册模板(50)的外围单元(48)，以生成独立于数据仓库(16)的手册(58)。

Description

生成技术手册的方法和系统

本发明涉及一种用于生成技术手册的方法和系统。

手册包括具有用于描述机器的信息的结构化表达的文档。

现有技术中，想要制作手册的档案保管员使用的数据仓库包括根据信息类型分类的信息条目：绘图、维护过程文本、组件描述，等等。

数据仓库是一种数据处理手段，用于一组数据或是其中每组涉及一种特定数据类型(维护，组建，等等)的一组数据组的有组织存储。存储或者由单个软件项来控制，或者由多个软件项来控制，每个软件项控制一组数据。

数据仓库通常包括一个或多个数据库，其中每个数据库中的数据根据通常和技术存储手段相关的特定结构而组织。

档案保管员结合相关信息，以生成想要的手册，该手册的形式通常为机器使用者所使用的手册结构。

数据仓库根据档案保管员的需求而特别设计。其包含的信息由没有资格使用档案保管员工具的技术人员提供。因为技术人员必须是合格的人，所以数据仓库的完成是复杂而耗时的。因此，数据仓库的信息通常不是最新的。

这样，现有技术的问题在于，手册一被制作出来，由档案管理员制作的手册的部分就可能是陈旧的。

本发明的目的是通过提出一种生成手册的方法以克服这个问题，该手册加入最新的描述机器的信息的条目。

为此目的，本发明涉及一种生成手册的方法，该手册包括具有描述机器的信息的结构化表达的文档，其特征在于，一方面，该方法包括步骤：

—生成一数据仓库，其包含信息条目，每个信息条目与至少一个机器的至少一个技术元素相关；以及，

—将数据仓库中的每个技术信息条目与其所相关的技术元素进行关联；并且，另一方面，后续步骤包括：

—生成由包括逻辑部分的手册结构所定义的手册模板，

—在手册模板结构的逻辑部分中，插入至少一个到从数据仓库的信息中所选择信息的条目的链接；以及

—控制用于编辑补充有链接的手册模板的外围单元，以生成独立于数据仓库的手册。

利用本发明，包括信息条目的数据仓库被配置为易于技术人员访问。技术人员可以凭借他们的知识(即机器的技术元素)实现数据仓库技术元素。

根据本发明的方法可以进一步包括一个或多个以下特征：

—来自数据仓库的至少一个信息条目包括到来自数据仓库的另一个信息条目的链接；

—该方法包括将链接到模板的信息条目复制到模板中的步骤；

—该方法包括生成模板结构的步骤；

—结构的生成包括导入已经生成的手册模板结构；

—该方法包括在数据仓库中关联具有至少一种手册类型的每个信息条目的步骤，从数据仓库恢复链接到模板所对应的手册类型的信息列表的步骤，以及显示所恢复的信息列表的步骤；

—显示步骤包括显示与信息列表相对的模板结构，并且该方法包括通过拖放信息到逻辑部分而从列表中选择结构的逻辑部分和信息条目的步骤；

—该方法包括格式化手册模板的步骤，其利用将预定的印刷风格与模板的每个逻辑部分相关联的样式表；

—控制外围编辑单元生成手册，该手册具有从以下的一种格式：pdf，html，word。

本发明还涉及一种生成手册的系统，该手册包括具有描述机器的信息的结构化表达的文档，该系统特征在于，一方面包括，包括信息条目的数据仓库，每个条目和至少一个机器的至少一个技术元素相关，在数据仓库中，每个信息条目与其相关的技术元素关联，以及，另一方面包括：

—用于生成由包括逻辑部分的手册结构所定义的手册模板的装置，

—用于在手册模板结构的逻辑部分中插入到至少一个从数据仓库的信息中所选择信息的条目的链接的装置，以及

—用于控制编辑补充有链接的手册模板的外围单元，以生成独立于数据仓库的手册的装置。

根据本发明的系统可以进一步包括一个或多个以下特征：

—来自数据仓库的至少一个信息条目，其包括到来自数据仓库的另一个信息条目的链接；

—该系统包括将链接到模板的信息条目复制到模板的装置；

—该系统包括用于生成模板结构的装置；

—用于生成结构的装置适用于导入已经生成的手册模板的结构；

—数据仓库中的每个信息条目与至少一种手册类型关联，且系统包括用于从数据仓库恢复链接到模板对应的手册类型的信息条目的装置，以及用于显示所恢复的信息列表的装置；

—显示装置可以显示对应于信息列表的模板结构，并允许所显示的信息条目被拖放到模板结构的逻辑部分；

—系统包括利用关联预定印刷类型与模板的每个逻辑部分的样式表来格式化手册模板的装置；

—系统包括外围编辑单元，其适于生成以下的一种格式的手册：pdf，html，word。

本发明将从以下描述中得到更好的理解，其完全通过例子并结合附图给出，其中：

—图1是根据本发明用于生成手册的系统的示意图；

—图2是信息模块的示意图；以及

—图3是表示由图1所示的系统执行的用于生成手册的方法的步骤框图。

在下面的描述中，数据仓库为数据库。当然，本发明可以直接应用于数据仓库的情况。

图1的系统，一般指定为10，包括依靠数据处理网络15相互通信的两个计算机12，14。

一个计算机12是数据服务器，其中安装有数据库16，其被称为全局库16，且包括每一个都和至少一个机器的至少一个技术元素相关的信息条目。

全局库16可以由技术人员18成员来完成。因此，数据服务器12包括人/机界面，该技术人员18通过该界面直接完成全局库16。数据服务器12进一步被连接到多个远程计算机19。不在数据服务器12所在地的技术人员18成员借助远程计算机19来远程实现全局库16。

在全局库16中，以模块封装的形式组织信息条目。

参照图2，每个模块20一方面包括，具有与一个或多个技术元素相关的信息的内容22；另一方面包括，包含定义模块20的数据条目的标识单元24。

对于与每个模块20(即模块20包括的信息条目22)相关的技术元素，标识单元24具体包括一个模块标识符26以及称为环境部分28的部分。

对于相应的技术元素，每个环境部分28具体地包括相应技术元素的标识符30，以及内容可被插入其中的手册的类型标识符32。手册的类型如以下所示：有插图的目录，具有维护任务的维护指南，包括维护工具的维护手册，备件列表。当然，这一目录不是限定性的并可以根据需求添加其他类型的手册。

模块的内容22是文字形式的(说明、维护过程等)或是图片形式的(技术制图、框图等)。该内容是结构化的。例如，文本内容包括逻辑部分的指示符：文章段落，编号步骤等。

内容可以是静态的，即在模块20中呈现信息；或动态的，即内容包括到存储于模块20外部的信息的链接33。

对于全局库16的一些模块，其内容22引用其他模块的一个或多个其他内容。该引用由链接34指示，该链接指向包括所链接内容的另一个模块。链接表示所链接模块的标识符26。

再次参照图1，另一个计算机14由想要生成手册的档案保管员36来使用，该手册包括具有描述机器的信息的结构化表达的文档，例如火车的车厢装置。

档案保管员的计算机14包括用于存储数字数据的装置38，例如硬盘，以及处理装置40：微处理器，RAM等，适用于执行软件程序，例如在存储装置38上记录的程序。此外，计算机14被连接到打印机42。

档案保管员36的计算机14上安装有三个软件组件44，46以及48。

标记为44的第一软件组件被设计用于创建用于完整的手册模板50的文件，即包含链接形式的信息的文件。

第一软件组件44包括人/机界面44A，档案保管员36通过该人/机界面44A与内容44进行交互，以引导档案保管员创建手册模板。下面陈述的所有功能都需使用该界面44的档案保管员36的干涉。

第一软件组件44首先包括定义手册类型的功能44B，允许档案保管员36指示他想要生成的手册的类型。

此外，第一软件组件44包括功能44C，用于恢复链接到所指示手册类型的全局库16中包含的模块的列表。

显示功能44D显示恢复的模块列表，并且显示对应模块列表的模板结构。

当功能44D启动时该结构是空白的。第一软件组件44提供选择性地实现：手工生成结构或导入已经生成的手册模板文件的结构。

列表中的每个模块可以通过拖拉的方式移动到结构的逻辑部分。即，第一软件组件44允许选择树形模块以及选择结构中的逻辑部分，其中，档案保管员36可以存储模块以关联它们。

第一软件组件44包括功能44E，用于生成模板文件50。在描述的例子中，文件50是XML格式。其使用档案保管员36指示的结构，该结构补充有由档案保管员插入的到模块的链接。

更确切地，用于生成模板文件的功能44E被设计为，对于档案保管员36链接的每个模块，插入文件50的关联模板的结构部分中的模块的链接。这意味着指示模块的标识符26的行被插入到XML文件50中。

这样，第一软件组件44在输出产生XML格式的手册模板文件50，其包括到档案保管员20希望手册包含的所有信息的链接。模板包含的链接所指向的模块被称为直接链接模块，同时，仅通过一个或几个其他模块、模块之间的链接34链接到模板的模块，被称为间接链接模块。

第一软件组件44适用于在存储装置38中存储该输出文件50并且启动搜索该文件50的第二软件组件46。

第一软件组件44还被设计为加载完成的模板XML文件，其已预先记录在存储装置38中，以被第二软件组件46使用。

第二软件组件46被用于准备编辑手册。其在输入等待完成的手册模板的XML文件50。在描述的例子中，组件46采用了自由软件COCOON(http：//cocoon.apache.org)的架构，针对本发明的特定需求确定其参数。

为了处理完成的模板文件50，编辑准备组件46包括三个连续的阶段，即以这种顺序执行：验证阶段46A，汇编阶段46B以及格式化阶段46C。

验证阶段46A配置为扫描模板文件50并验证存在于全局库16中直接链接到模板的每个模块，即，对于模板包含到该模块的链接。该阶段46A也配置为当这种模块不存在时删除链接并在其位置上插入出错信息。

如果需要，验证阶段46A进一步配置为验证链接模块的动态内容。这意味着其可以验证动态内容包含的链接33指向有效的数据项。

第二汇编阶段46B配置为执行三种操作。

首先，执行将直接从全局库16直接链接到存储装置38的模块复制到中间数据库52的操作。

接着，对于每个直接链接的模块，执行的操作包含在模板文件50中，代替链接，将模块所包含的内容，即信息拷贝至此。

最后，第三操作包含，当完成前述操作时，扫描模板文件50，以检测其包含的链接和模块之间的链接34所生成的链接，即前述操作期间所复制信息中包含的链接。如果链接34指向的模块也被直接链接，该链接34被替换为模块信息已被插入的模板的结构的逻辑部分。如果链接34执行的模块是间接链接的，即，档案保管员没有在模板中插入，该链接34被删除。

第三格式化阶段46C配置为利用关联预定印刷类型与结构、模板、或复制内容的每个部分的样式表56格式化被验证以及被汇编的模板。该样式表具体地指示字体、字符大小、下划线等，其被用于所有模板文件50的每个逻辑部分：章、段、节、非正式注释，高亮文本等。

该第三阶段46C也被设计为控制第三软件组件。

第三软件组件的参考标号为48并且，是一外围单元，用于编辑模板文件50在第二处理软件组件46的输出处提供的手册。在描述的例子中，其可以生成pdf文档58并在存储装置38内记录该文档。以这种方式，存储装置38包含最终手册，手册处于被提交给各自的客户的状态。

在其他实施例中，外围编辑单元48可以生成HTML文件或Word文件等。

最后，第三软件组件48包括控制文件58生成的打印机42的功能，以获取打印的手册。

生成图3所示的产生手册的方法包括两个主要阶段：阶段100用于初始化系统10，并且阶段200用于执行该系统10。执行阶段200由档案保管员16对于每个新手册的生成而重复，同时初始化阶段100由技术人员18成员在包括阶段200执行期间和之后以连续的方式来执行，因此全局库16包括最新的可用信息。

初始化阶段100包括生成全局库16的第一步骤110，以及在全局库16中将每个模块与其所包括信息所涉及的技术元素相关联的第二步骤120。在步骤120期间，模块也关联于至少一种手册类型。

执行阶段200包括第一步骤202，其中档案保管员36启动第一软件组件44。

他在步骤204期间执行功能44B以向软件组件44指示他想要生成的手册类型。

第一软件组件44在步骤206期间执行功能44C，用于恢复链接到所指示手册类型的模块的列表。

接着，在步骤208期间，第一软件组件44执行功能44D，用于显示空白模板结构以及模块列表。档案保管员也在该步骤208期间生成结构。

在步骤210期间，档案保管员20通过将模块从模块列表拖放到模板结构的逻辑部分来完成手册模板。

前述步骤210可以按照档案保管员20的需求重复多次。

当档案保管员20结束完成操作，他控制第一软件组件44，以在功能44E执行的步骤212期间生成完成的手册模板的XML文件50。第一软件组件44存储这个文件到存储装置38中，且启动第二软件组件4，6以编辑手册模板50。

编辑一般在步骤210之后直接执行用于完成模板。然而，编辑操作也可以在模板文件被生成并存储之后很久发生，有时为几个月。例如，当客户想要获取其手册的新的更新版本时的情况。

编辑由编辑准备组件46以及编辑组件48执行，不需要档案保管员36的参与。

以这种方式，执行阶段200包括由验证阶段46A执行的步骤214，用于验证模板文件50。

接着由汇编阶段46B执行的步骤216，用于汇编模板。阶段46B可以执行的三个操作被实现。这三个操作在图3中以子步骤216A，216B以及216C来表示。

格式化阶段46C接着利用样式表56执行手册模板的格式化(步骤218)，其已经由档案保管员36预先指定。

在最后的控制步骤220期间，第二软件组件46控制第三软件组件48以执行两个操作。首先，在第二软件组件46的各个阶段执行处理操作后，从所获得的模板文件生成(220A)pdf格式的最终手册。构成最终手册的pdf文件58存储在存储装置38内。接着，外围编辑单元48控制(220B)打印机42，以打印文件并获得最终的打印手册。

最终手册独立于全局库16，也就是说，档案保管员31希望其包含的信息没有链接到该库16。

参照图1中的说明，在其他实施例中，控制外围编辑单元可以依靠所使用的外围单元48的特性生成html或Word格式的手册，以使打印机42接下来对其进行打印。

Claims (18)

1、生成手册的方法，该手册包括具有描述机器的信息的结构化表达的文档，其特征在于，一方面，该方法包括下列步骤：：

-生成(110)一数据仓库(16)，其包括多个信息条目，每个信息条目与至少一个机器的至少一个技术元素相关；以及，

-将该数据仓库(16)中的每个信息条目与其所相关的该技术元素进行关联(120)；并且，另一方面，后续步骤包括：

-生成(212)由包括逻辑部分的手册结构所定义的手册模板(50)，

-在自该手册模板(50)结构选择的逻辑部分中，插入(212)到从该数据仓库(16)的信息中所选择的信息条目的至少一个链接；以及

-控制(220)用于编辑补充有链接的该手册模板(50)的外围单元(48)，以生成独立于该数据仓库(16)的手册(58)。

2、根据权利要求1的方法，其特征在于，来自所述数据仓库(16)的至少一个信息条目包括到来自所述数据仓库(16)的另一个信息条目的链接(34)。

3、根据权利要求1或2的方法，其特征在于，该方法包括将链接到所述模板(50)的所述信息条目复制到所述模板(50)中的步骤(216)。

4、根据权利要求1-3的任意一项的方法，其特征在于，该方法包括生成模板结构(50)的步骤。

5、根据权利要求4的方法，其特征在于，结构的生成包括导入已经形成的手册模板的结构。

6、根据权利要求1-5的任意一项的方法，其特征在于，该方法包括：

-在所述数据仓库(16)中将每个信息条目与至少一种手册类型相关联的步骤(120)，

-从所述数据仓库(16)恢复链接到模板对应的手册类型的信息列表的步骤(206)，以及

-显示所恢复信息的该列表的步骤(208)。

7、根据权利要求6的方法，其特征在于，所述显示步骤(208)包括显示对应信息列表的所述模板结构，并且该方法包括通过拖放信息到逻辑部分而从所述列表选择所述结构的逻辑部分和信息条目的步骤。

8、根据前述任意一项权利要求的方法，其特征在于，该方法包括格式化所述手册模板(50)的步骤(218)，该步骤利用将预定印刷类型与所述模板(50)的每个逻辑部分相关联的样式表(56)。

9、根据前述任意一项权利要求的方法，其特征在于，控制生成所述手册的所述外围编辑单元(48)，所述手册具有从以下选择的一种格式：pdf，html，Word。

10、生成手册的系统，该手册包括具有描述机器的信息的结构化表达的文档，该系统的特征在于，一方面：包括包含有信息条目的数据仓库(16)，每个该信息条目与至少一个机器的至少一个技术元素相关，在该数据仓库(16)中，每个信息条目与其相关的技术元素关联；以及，另一方面，包括：

-装置(44E)，用于生成由包括逻辑部分的手册结构所定义的手册模板(50)，

-装置(44E)，用于在所述手册模板结构(50)的逻辑部分中插入到从所述数据仓库(16)的信息中所选择信息条目的至少一个链接，以及

-装置(46C)，用于控制编辑补充有链接的所述手册模板(50)的外围单元(48)，以生成独立于所述数据仓库(16)的手册(58)。

11、根据权利要求10的系统，其特征在于，来自所述数据仓库(16)的至少一个信息条目包括到来自所述数据仓库(16)的另一个信息条目的链接(34)。

12、根据权利要求10或11的系统，其特征在于，该系统包括用于向所述模板(50)复制链接到所述模板的所述信息条目的装置(46B)。

13、根据权利要求10到12中任意一项的系统，其特征在于，该系统包括用于生成模板结构(50)的装置(44D)。

14、根据权利要求13的系统，其特征在于，用于生成结构的装置(44D)适用于导入已经生成的手册模板的结构。

15、根据权利要求10到14中任意一项的系统，其特征在于，所述数据仓库中的每个信息条目与至少一种手册类型关联，且该系统包括：

-装置(44C)，用于从所述存储(16)中恢复链接到所述模板对应的所述手册类型的的信息条目，以及

-装置(44D)，用于显示所恢复的所述信息的列表。

16、根据权利要求15的系统，其特征在于，所述显示装置(44D)可以显示对应于所述信息列表的所述模板结构，并且所述显示装置(44D)允许将显示的信息条目拖放到所述模板结构的逻辑部分。

17、根据权利要求10到16中的任意一项的系统，其特征在于，该系统包括格式化所述手册模板(50)的装置(46C)，该装置(46C)利用关联预定印刷类型与所述模板的每个逻辑部分的样式表(56)。

18、根据权利要求10到17中的任意一项的系统，其特征在于，该系统包括所述外围编辑单元(48)，并且该单元适于生成所述手册(58)，所述手册(58)具有从以下选择的一种格式：pdf，html，word。

Images