JP2007128520A - マニュアルの作成方法及びそのシステム - Google Patents

Abstract

【課題】外部情報へのリンクを含まないマニュアルを作成すること。
【解決手段】グローバルデータウェアハウス(16)を出所とする少なくとも１つの情報アイテムからマニュアルを作成するためのシステム。該グローバルデータウェアハウス(16)からの各情報アイテムが該グローバルデータウェアハウス(16)からの別の情報アイテムへのリンク(34)を含むことが可能。本システムは、前記グローバルデータウェアハウス(16)からの少なくとも１つの情報アイテムをマニュアル内にコピーする手段(46A)と、コピーされた情報アイテム内に含まれる各リンク(34)について前記マニュアルをスキャンする手段(46B)であって、リンクされた情報が該マニュアル内にコピーされている場合には、該リンクを、前記マニュアル内のコピーが行われた場所における明示的な参照に置換し、リンクされた情報が前記マニュアル内にコピーされていない場合には、該リンクを削除する、手段(46B)とを含む。
【選択図】図１

Description

本発明は、マニュアルの作成方法及びそのシステムに関し、特に技術的なマニュアルを作成する分野に関するものである。マニュアルは、マシンを説明する情報の構造化された提示を有するドキュメントから構成される。

従来技術では、マニュアルの作成を望む記録保管人は、情報のタイプ（すなわち、図面、メンテナンス手順のテキスト、部品の説明、その他）によって分類された情報アイテムを含むデータウェアハウスを使用する。

データウェアハウスは、一組のデータ、又は各グループが特定のタイプのデータに関連する一組のデータグループ（メンテナンス、部品、その他）を整理して格納するための、データ処理手段である。その格納は、単一のソフトウェアアイテムにより、又は複数のソフトウェアアイテム（各アイテムが１グループのデータを制御する）により、制御される。

データウェアハウスは、一般に１つ又は２つ以上のデータベースを含み、その各データベース内には、一般に技術的な記憶手段に関連する特定の構造に従ってデータが整理される。

記録保管人は、所望のマニュアルを作成するための関連情報をマニュアル構造内に取り込み、該マニュアル構造は、一般にマシンのユーザにより課せられるものである。

データウェアハウス内に含まれる各情報アイテム自体は、該データウェアハウスの別の情報アイテムへのリンクを含むことが可能である。

このように、従来技術の問題は、記録保管人により生成されるマニュアルがマニュアルの外部の情報へのリンクを含むことにあり、これは許容できないことである。

本発明の目的は、データウェアハウスとは独立したデータファイル内に収集すべき少なくとも１つの情報アイテムを収集するための方法を提案することにより上記の問題を克服することにある。

この目的のため、本発明は、グローバルデータウェアハウスを出所とする少なくとも１つの情報アイテムからマニュアルを作成するための方法に関するものであり、該グローバルデータウェアハウスからの各情報アイテムは、該グローバルデータウェアハウスからの別の情報アイテムへのリンクを含むことが可能なものであり、該方法は、
前記グローバルデータウェアハウスからの少なくとも１つの情報アイテムをマニュアル内にコピーし、
コピーされた情報アイテム内に含まれる各リンクについて前記マニュアルをスキャンし、
リンクされた情報が前記マニュアル内にコピーされている場合には、該リンクを、前記マニュアル内のコピーが行われた場所における明示的な参照に置換し、
リンクされた情報が前記マニュアル内にコピーされていない場合には、該リンクを削除する、
という各ステップを含むことを特徴とするものである。

本発明によれば、削除されたマニュアルの外部の情報へのリンクだけでなく、ファイル内の情報アイテムへのリンク（すなわち、その内部にコピーされたもの）も更新される。このため、取得されたファイルは完備かつ独立したものとなる。

本発明による方法は、以下に示す１つ又は２つ以上の特徴を更に含むことが可能である。
− 少なくとも１つの情報アイテムをコピーするステップに先立ち、コピーすべき各情報アイテムへのリンクをマニュアル内に挿入し、該マニュアルをスキャンし、リンクが発見された際に、該マニュアルにリンクされた情報がグローバルデータウェアハウス内に存在することを検証し、該情報が存在しない場合には該リンクを削除する、という各ステップを含む。
− 前記マニュアルがＸＭＬ形式のデータファイルである。
− 前記コピーステップが、リンクされた情報アイテムの各々を該リンクの代わりにコピーするステップを含む。

本発明はまた、グローバルデータウェアハウスを出所とする少なくとも１つの情報アイテムからマニュアルを作成するためのシステムに関するものであり、該グローバルデータウェアハウスからの各情報アイテムは、該グローバルデータウェアハウスからの別の情報アイテムへのリンクを含むことが可能なものであり、該システムは、
前記グローバルデータウェアハウスからの少なくとも１つの情報アイテムをマニュアル内にコピーする手段と、
コピーされた情報アイテム内に含まれる各リンクについて前記マニュアルをスキャンする手段であって、リンクされた情報が該マニュアル内にコピーされている場合には、該リンクを、前記マニュアル内のコピーが行われた場所における明示的な参照に置換し、リンクされた情報が前記マニュアル内にコピーされていない場合には、該リンクを削除する、手段と
を含むことを特徴とするものである。

本発明によるシステムは、以下に示す１つ又は２つ以上の特徴を更に含むことが可能である。
− コピーすべき各情報アイテムへのリンクをマニュアル内に挿入する手段と、該マニュアルをスキャンする手段であって、リンクが発見された際に、該マニュアルにリンクされた情報がグローバルデータウェアハウス内に存在することを検証し、該情報が存在しない場合には該リンクを削除する、手段とを含む。
− 前記マニュアルがＸＭＬ形式のファイルである。

本発明は、純粋に例示として提示し図面を参照する以下の説明から一層良好に理解されよう。

以下の説明では、データウェアハウスはデータベースである。勿論、本発明は、データウェアハウスの場合に直接適用可能なものである。

包括的に符号10で示す図１のシステムは、データ処理ネットワーク15を介して互いに通信するコンピュータ12,14を含む。

一方のコンピュータ12は、データベース16がインストールされたデータサーバである。該データベース16は、グローバルベース16と呼ばれるものであり、少なくとも１つのマシンの少なくとも１つの技術的な要素にそれぞれ関連する情報アイテムを含むものである。

該グローバルベース16は、技術スタッフ18のメンバーにより完成させることが意図されたものである。このため、データサーバ12は、該技術スタッフ18のメンバーがグローバルベース16を直接完成させるためのマン／マシン・インタフェイスを含む。データサーバ12は更に複数のリモートコンピュータ19に接続される。データサーバ12が配置されている場所にいない技術スタッフ18のメンバーは、それらリモートコンピュータ19を使用することによりグローバルベース16を遠隔地から完成させる。

グローバルベース16において、情報アイテムは、モジュール内のカプセル化により編成される。

図２を参照すると、各モジュール20は、一方では、１つ又は２つ以上の技術的な要素に関連する情報を含む内容22を含み、他方では、モジュール20を定義するデータアイテムを含む識別ユニット24を含む。

該識別ユニット24は、詳細には、モジュール20（すなわち、それが収容する情報アイテム22）が関係する技術的な要素の各々毎にモジュール識別子26及び環境部分28と呼ばれる部分を含む。

各環境部分28は、詳細には、対応する技術的な要素について、該対応する技術的な要素の識別子30と、該内容を挿入することができるマニュアルの形式の識別子32とを含む。マニュアルの形式は、イラスト入りカタログ、メンテナンス作業を含むメンテナンスガイド、メンテナンスツールを含むメンテナンスマニュアル、及びスペアパーツのリストといったものである。勿論、このリストは、本発明を限定するものではなく、必要に応じて他の形式のマニュアルを追加することが可能である。

モジュールの内容22は、テキスト（説明、メンテナンス手順、その他）又はグラフィクス（技術図面、ブロック図、その他）の何れかである。この内容は、構造化されたものである。例えば、テキスト内容は、論理的な部分の指示子、すなわち、章・段落、番号付与された段、その他を含むものとなる。

内容は、静的なもの（この場合、情報はモジュール20内に存在する）、又は動的なもの（この場合、内容はモジュール20の外部に格納されている情報へのリンク33を含む）とすることが可能である。

グローバルベース16のモジュールによっては、その内容22は、他のモジュールの１つ又は２つ以上の他の内容を参照するものとなる。この参照は、リンクされた内容を含む他のモジュールへのリンク34の存在によって指示される。該リンクは、リンクされたモジュールについての識別子26を指示するものである。

図１を再び参照すると、他方のコンピュータ14は、マシン（列車の客車設備（carriage set）等）を解説した構造化された情報の提示を有するドキュメントを含むマニュアルの作成を望む記録保管人36によって使用されることが意図されたものである。

記録保管人のコンピュータ14は、数値データを格納するための記憶手段38（例えばハードディスク）、及び（例えば該記憶手段38に格納された）ソフトウェアプログラムの実行に適した処理手段40（すなわち、マイクロプロセッサ、ＲＡＭ、その他）を含む。更に、コンピュータ14はプリンタ42に接続される。

３つのソフトウェアコンポーネント44,46,48は、記録保管人36のコンピュータ14上にインストールされる。

第１のソフトウェアコンポーネント44は、完成したマニュアルテンプレート50のための（すなわち、リンクという形の情報を含む）ファイルを作成するために設計されたものである。

第１のソフトウェアコンポーネント44は、マン／マシン・インタフェイス44Aを含み、該インタフェイスを介して記録保管人36が該コンポーネント44と対話し、該記録保管人にマニュアルテンプレートの作成が案内される。以下で説明する全ての機能は、このインタフェイス44を使用した記録保管人36の介在を必要とするものである。

先ず、第１のソフトウェアコンポーネント44は、マニュアル形式を定義するための機能44Bを含み、該機能により、記録保管人36が作成を望むマニュアルの形式を指示することが可能となる。

更に、第１のソフトウェアコンポーネント44は、グローバルベース16に収容されているモジュールのうち指示されたマニュアルの形式にリンクしているモジュールのリストを回復するための機能44Cを含む。

表示機能44Dは、回復されたモジュールのリストを表示し、及び該モジュールのリストに反するテンプレートの構造を表示する。

この構造は、機能44Dが開始されたときは白紙状態である。第１のソフトウェアコンポーネント44は、構造を手作業で作成する、又は既に作成されているマニュアルテンプレートファイルの構造をインポートする、という選択肢を提供する。

前記リストの各モジュールは、ドラッグ・アンド・ドロップにより構造の論理的な部分へ移動することが可能である。すなわち、第１のソフトウェアコンポーネント44は、ツリーモジュールの選択、及び記録保管人36が該モジュールを関連付けするために該モジュールを配置することを望む構造内の論理的な部分の選択を可能にする。

第１のソフトウェアコンポーネント44は、テンプレートファイル50を作成するための機能44Eを含む。説明する例では、ファイル50はＸＭＬフォーマットとなる。該ファイル50は、記録保管人36により指示された構造を有し、該記録保管人36により挿入されたモジュールへのリンクが追加されたものとなる。

より詳細には、テンプレートファイルを作成するための機能44Eは、記録保管人36によりリンクされた各モジュール毎に、該モジュールへのリンクを、ファイル50の関連するテンプレートの構造の部分内に挿入するよう設計される。これは、モジュールの識別子26をを示す１つの行がＸＭＬファイル50内に挿入されることを意味している。

このようにして、第１のソフトウェアコンポーネント44は、その出力として、記録保管人36がマニュアルに含まれていることを望む全ての情報へのリンクを含むＸＭＬフォーマットで、マニュアルテンプレートファイル50を生成する。テンプレートに含まれるリンクの宛先となるモジュールは、直接リンクされたモジュールと呼ばれ、一方、１つ又は２つ以上の他のモジュールによってのみ（モジュール間のリンク34によって）テンプレートにリンクされたモジュールは、間接リンクされたモジュールと呼ばれる。

第１のソフトウェアコンポーネント44は、この出力ファイル50を記憶手段38に格納し、及び該ファイル50をサーチするために第２のソフトウェアコンポーネント46を起動させるのに適したものである。

第１のソフトウェアコンポーネント44はまた、第２のソフトウェアコンポーネント46により使用するために記憶手段38に予め記録された完成したテンプレートのＸＭＬファイルをロードするよう設計される。

第２のソフトウェアコンポーネント46は、マニュアルの編集の準備を行うために使用される。該第２のソフトウェアコンポーネント46は、その入力に完成したマニュアルテンプレートのＸＭＬファイル50が提供されるのを待機する。説明する例では、第２のソフトウェアコンポーネント46は、フリーソフトウェアCOCOON（http://cocoon.apache.org）のアーキテクチャを利用し、これを本発明の特定の要件に関してパラメータ化したものとなる。

編集準備コンポーネント46は、完成したテンプレートファイル50を処理するための３つの連続したステージ、すなわち、検証ステージ46A、収集ステージ46B、及びフォーマットステージ46Cを含み、その順番通りに実行される。

検証ステージ46Aは、テンプレートファイル50をスキャンして、該テンプレートに直接リンクされている各モジュール、すなわち、該テンプレートに含まれるリンクの宛先となっている各モジュールが、グローバルベース16内に存在することを検証する。このステージ46Aはまた、このモジュールが存在しない場合にリンクを削除してその場所にエラーメッセージを挿入するよう構成されている。

検証ステージ46Aは更に、必要に応じて、リンクされたモジュールの動的な内容を検証するように構成されている。これは、動的な内容に含まれるリンク33が有効なデータアイテムを指していることを検証することができることを意味している。

２番目の収集ステージ46Bは、３つの操作を実行すべく構成されている。

まず最初に、収集ステージ46Bは、グローバルベース16から記憶手段38へ直接リンクされているモジュールを中間データベース52内にコピーするための操作を実行する。

次いで、収集ステージ46Bは、直接リンクされている各モジュール毎に、情報、すなわち、該モジュールに含まれている内容を、テンプレートファイル50内におけるそのリンクの場所にコピーすることを含む操作を実行する。

最後に、第３の操作は、それに先行する操作が完了した際に、テンプレートファイル50に含まれるリンク、及びモジュール間のリンク34に由来するリンク、すなわち、先行する操作中にコピーされた情報に含まれるリンクを検出するために、該テンプレートファイル50をスキャンすることを含む。該リンク34が、直接リンクもされているモジュールを指す場合には、該リンク34が、テンプレートの構造の論理的な部分のうち該モジュールの情報が挿入された部分への参照と置換される。該リンク34が、間接リンクされているモジュール、すなわち、記録保管人がテンプレート中に挿入したものでないモジュールを指す場合には、該リンク34が削除される。

３番目のフォーマットステージ46Cは、検証され収集されたテンプレートを、該テンプレート又はコピーされた内容の構造の各部分に所定の活字形式を関連付けするスタイルシート56を使用して、フォーマットすべく構成されている。このスタイルシートは、詳細には、全てのテンプレートファイル50の論理的な部分（すなわち、章、節、段落、非公式のメモ、強調されたテキスト、その他）の各々毎に使用すべき、フォント、文字大きさ、下線、その他を指示するものである。

この３番目のステージ46Cはまた、第３のソフトウェアコンポーネントを制御するよう設計されている。

第３のソフトウェアコンポーネント48は、第２の処理ソフトウェアコンポーネント46の出力において提供されるテンプレートファイル50からマニュアルを編集するための周辺装置である。説明する例では、該第３のソフトウェアコンポーネント48は、ＰＤＦドキュメント58を生成して該ドキュメントを記憶手段38内に記録することができるものである。このようにして、記憶手段38は、最終的なマニュアルを、個々のクライアントに配布されるときの状態で収容する。

別の実施形態では、編集用周辺装置48は、プリントされたマニュアルを取得するために生成されたファイル58からプリンタ42を制御するための機能を含む。

図３に示すマニュアル生成方法は、２つの主な段階、すなわち、システム10を初期化する段階100、及び該システム10を実行する段階200を含む。該実行段階200は、新たなマニュアルを作成するたびに記録保管人36により繰り返され、一方、前記初期化段階100は、技術スタッフのメンバーにより前記実行段階200の実行中及びその後を含めて絶えず継続的に行われ、これによりグローバルベース16が利用可能な最新情報を含むようになる。

初期化段階100は、グローバルベース16の作成を伴う第１ステップ110と、該グローバルベース16において各モジュールに含まれる情報が参照する技術的な要素に該モジュールを関連付けすることを伴う第２ステップ120とを含む。このステップ120中に、モジュールはまた、少なくとも１つのマニュアル形式に関連付けされる。

実行段階200は、第１ステップ202を含み、該第１ステップ202中に、記録保管人36が第１のソフトウェアコンポーネント44を起動させる。記録保管人36は、ステップ204中に、作成したいマニュアルの形式を第１のソフトウェアコンポーネント44に指示するために、機能44Bを実行する。

第１のソフトウェアコンポーネント44は、ステップ206中に、指示されたマニュアルの形式にリンクされたモジュールのリストを回復させるために機能44Cを実行する。

次いで、ステップ208中で、第１のソフトウェアコンポーネント44は、白紙状態のテンプレート構造とモジュールリストとを表示する機能44Dを実行する。記録保管人はまた、ステップ208中で該構造を作成する。

ステップ210中に、記録保管人20は、モジュールリストからテンプレートの構造の論理的な部分へモジュールをドラッグ・アンド・ドロップすることにより、マニュアルテンプレートを完成させる。

前記ステップ210は、記録保管人20が必要とする回数だけ繰り返される。

記録保管人20は、前記のマニュアルテンプレートを完成させる操作が終了すると、機能44Eにより実行されたステップ212中に、完成したマニュアルテンプレートのＸＭＬファイル50を生成するように第１のソフトウェアコンポーネント44を制御する。第１のソフトウェアコンポーネント44は、このファイルを記憶手段38内に格納し、マニュアルテンプレート50を編集するために第２のソフトウェアコンポーネント46を起動させる。

該編集は、一般に、テンプレートを完成させるためのステップ210の直後に行われる。しかし、該編集操作は、テンプレートファイルが作成され格納された後、長い時間（場合によっては数ヶ月）をかけることも可能である。例えば、クライアントが自身のマニュアルの更新版を取得することを望んでいる場合がそれに該当する。

該編集は、記録保管人36を伴わずに編集準備コンポーネント46及び編集コンポーネント48により実行される。

このように、実行段階200は、検証ステージ46Aにより実行されるテンプレートファイル50の検証のためのステップ214を含む。

次いで、収集ステージ46Bにより実行されるテンプレートを収集するためのステップ216が実行される。このステージ46Bが実行することができる３つの操作が実施される。これら３つの操作は、図３にサブステップ216A,216B,216Cで示されている。

次いで、フォーマットステージ46Cは、記録保管人36により予め指定されたスタイルシート56を使用してマニュアルのフォーマット処理（ステップ218）を実行する。

最後の制御ステップ220中に、第２のソフトウェアコンポーネント46が、２つの操作を実行するよう第３のコンポーネント48を制御する。最初に、ソフトウェアコンポーネント46の様々なステージにより実行された処理に続いて得られたテンプレートファイルからＰＤＦフォーマットで最終的なマニュアルを生成する（ステップ220A）。この最終的なマニュアルを構成するＰＤＦファイル58が記憶手段38内に格納される。次いで、編集用周辺装置48が、該ファイルをプリントして最終的なプリントされたマニュアルを得るためにプリンタ42を制御する（220B）。

この最終的なマニュアルは、グローバルベース16とは独立したものであり、すなわち、記録保管人36が該マニュアルに含まれていることを望む情報はこのグローバルベース16にはリンクされていない。

図１に関して説明したように、別の実施形態では、編集用周辺機器を制御することにより、使用される該編集用周辺装置48の特性に依存して、HTML形式又はWord(R)形式でマニュアルを生成することが可能であり、次いで該生成されたマニュアルがプリンタ42によりプリントされることになる。

本発明によるマニュアルを作成するためのシステムを示す概略図である。 情報モジュールを示す概略図である。 図１のシステムにより行われるマニュアルを生成するための方法の各ステップを示すブロック図である。

符号の説明

10 システム
12,14 コンピュータ
15 データ処理ネットワーク
16 グローバルベース
19 リモートコンピュータ
38 記憶手段
40 処理手段
42 プリンタ
44,46,48 ソフトウェアコンポーネント
50 マニュアルテンプレート
52 中間データベース
56 スタイルシート
58 ＰＤＦドキュメント

Claims (7)

1. グローバルデータウェアハウス(16)を出所とする少なくとも１つの情報アイテムからマニュアルを作成するための方法であって、該グローバルデータウェアハウス(16)からの各情報アイテムは、該グローバルデータウェアハウス(16)からの別の情報アイテムへのリンク(34)を含むことが可能なものであり、
   前記グローバルデータウェアハウス(16)からの少なくとも１つの情報アイテムをマニュアル内にコピーし(216B)、
   コピーされた情報アイテム内に含まれる各リンク(34)について前記マニュアルをスキャンし(216C)、
   リンクされた情報が前記マニュアル内にコピーされている場合には、該リンクを、前記マニュアル内のコピーが行われた場所における明示的な参照に置換し、
   リンクされた情報が前記マニュアル内にコピーされていない場合には、該リンクを削除する、
   という各ステップを含むことを特徴とする方法。
2. 少なくとも１つの情報アイテムをコピーする前記ステップに先立ち、
   コピーすべき各情報アイテムへのリンクをマニュアル内に挿入し(212)、
   該マニュアルをスキャンし、リンクが発見された際に、該マニュアルにリンクされた情報がグローバルデータウェアハウス(16)内に存在することを検証し(214)、
   該情報が存在しない場合には該リンクを削除する、
   という各ステップを含むことを特徴とする、請求項１に記載の方法。
3. 前記マニュアルがＸＭＬ形式のデータファイルであることを特徴とする、請求項１又は請求項２に記載の方法。
4. 前記コピーステップ(216B)が、リンクされた各情報アイテムを該リンクの代わりにコピーするステップを含むことを特徴とする、請求項２に記載の方法。
5. グローバルデータウェアハウス(16)を出所とする少なくとも１つの情報アイテムからマニュアルを作成するためのシステムであって、該グローバルデータウェアハウス(16)からの各情報アイテムが、該グローバルデータウェアハウス(16)からの別の情報アイテムへのリンク(34)を含むことが可能なものであり、
   前記グローバルデータウェアハウス(16)からの少なくとも１つの情報アイテムをマニュアル内にコピーする手段(46A)と、
   コピーされた情報アイテム内に含まれる各リンク(34)について前記マニュアルをスキャンする手段(46B)であって、リンクされた情報が該マニュアル内にコピーされている場合には、該リンクを、前記マニュアル内のコピーが行われた場所における明示的な参照に置換し、リンクされた情報が前記マニュアル内にコピーされていない場合には、該リンクを削除する、手段(46B)と
   を含むことを特徴とするシステム。
6. コピーすべき各情報アイテムへのリンクをマニュアル内に挿入する手段(30D)と、
   該マニュアルをスキャンする手段であって、リンクが発見された際に、該マニュアルにリンクされた情報がグローバルデータウェアハウス(16)内に存在することを検証し、該情報が存在しない場合には該リンクを削除する、手段(32A)と
   を含むことを特徴とする、請求項５に記載のシステム。
7. 前記マニュアルがＸＭＬ形式のファイルであることを特徴とする、請求項５又は請求項６に記載のシステム。

Images