JP2008242804A - Ｗｅｂシステムマニュアル生成装置 - Google Patents

Abstract

【課題】新たにシステムの仕様を記述することなく、システムの設計結果を入力としてマニュアルを生成することができるＷｅｂシステムマニュアル作成装置を得ること。
【解決手段】タグ情報処理部１５１が、Ｗｅｂシステムの設計結果である該Ｗｅｂシステムのページの表示画面を定義した画面定義データに記述されたタグ情報の中から関連するタグ情報を抽出し、抽出したタグ情報に対応する基本説明文に基づいて当該タグ情報によって表示される表示画面の説明文を生成し、画面情報説明作成部１５２が説明文と画面定義データによって表示されるページの画面イメージとをマージして当該画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成し、マニュアル生成／表示処理部１６がページ毎の画面説明データをＷｅｂシステムのマニュアルとしてまとめて表示する。
【選択図】 図１

Description

本発明は、Ｗｅｂシステムのマニュアルを生成するＷｅｂシステムマニュアル生成装置に関するものであり、特に、Ｗｅｂシステムの設計結果である画面定義データやプログラムを入力として当該Ｗｅｂシステムのマニュアルを生成するＷｅｂシステムマニュアル生成装置に関するものである。

従来から、Ｗｅｂシステムのマニュアルを生成する種々の技術が考えられている。たとえば、特許文献１には、システムの仕様を形式的に記述した仕様記述を利用して、画面イメージを含むドキュメント（マニュアル）を自動生成する画面イメージ付きドキュメント生成装置に関する技術が開示されている。

具体的には、システムの仕様記述を入力する入力手段、入力手段によって入力された仕様記述からユーザのシステムへの入力操作手順を抽出する抽出手段、ユーザの入力操作をシミュレートする操作シミュレータ、入力操作手順を操作シミュレータが実行するスクリプトに変換する変換手段、操作シミュレータを使って画面イメージを取得するための実行スクリプトを生成する生成手段、および画面イメージを取得するための実行スクリプトと入力操作順序を実行するスクリプトとを合成する合成手段とを備え、操作シミュレータが、合成スクリプトにしたがってシミュレートを実行し、この画面イメージと仕様記述、または仕様記述から抽出した機能情報とを合成して、画面イメージを取り込んだマニュアルを作成する。

特開平８−３２９２７１号公報

しかしながら、上記特許文献１に記載の従来技術では、ドキュメント生成装置へのシステムの仕様の入力は予め定められたフォーマットで記述しなければならない。すなわち、システムの仕様書や設計結果物などとは別に、マニュアル生成のための仕様記述を作成しなければならない。そのため、マニュアル生成のための仕様記述を作成する手間と時間がかかってしまうという問題があった。この問題は、システムの条件や機能の多くなるほど顕著になる。

また、システムの仕様書や設計結果物などとは別に、マニュアル生成のための仕様を入力しなければならないため、仕様の入力漏れなどが発生してしまうことも考えられ、そのチェックのための時間も必要となり、さらに、手間と時間がかかってしまうという問題があった。

本発明は、上記に鑑みてなされたものであって、新たにシステムの仕様を記述することなく、システムの設計結果を入力としてマニュアルを生成することができるＷｅｂシステムマニュアル作成装置を得ることを目的とする。

上述した課題を解決し、目的を達成するために、本発明は、Ｗｅｂシステムの設計結果である該Ｗｅｂシステムのページの表示画面を定義した画面定義データ、および該画面定義データで用いられるプログラムが記述されたプログラムファイルに基づいて前記Ｗｅｂシステムのマニュアルを生成するＷｅｂシステムマニュアル生成装置であって、前記画面定義データを記述する言語の各タグ情報に対応付けて当該タグ情報における表示の基本説明文が登録される説明文パターン蓄積データベースと、前記画面定義データに記述されたタグ情報の中から関連するタグ情報を抽出し、抽出したタグ情報に対応付けて前記説明文パターン蓄積データベースに登録されている基本説明文に基づいて当該タグ情報によって表示される表示画面の説明文を生成するタグ情報処理部と、前記タグ情報処理部によって生成された説明文と前記画面定義データによって表示されるページの画面イメージとをマージして当該画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成する画面情報説明作成部と、前記画面情報説明作成部によって作成された前記Ｗｅｂシステムのページ毎の画面説明データをマニュアルとしてまとめて表示させるマニュアル生成／表示処理部と、を備えることを特徴とする。

この発明によれば、Ｗｅｂシステムの設計結果である該Ｗｅｂシステムのページの表示画面を定義した画面定義データに記述されたタグ情報の中から関連するタグ情報を抽出し、抽出したタグ情報に対応する基本説明文に基づいて当該タグ情報によって表示される表示画面の説明文を生成し、生成した説明文と画面定義データによって表示されるページの画面イメージとをマージして当該画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成し、作成したページ毎の画面説明データをＷｅｂシステムのマニュアルとしてまとめて表示するようにしているため、新たにシステムの仕様を記述することなく、システムの設計結果を入力としてマニュアルを生成することができるＷｅｂシステムマニュアル生成装置を得ることができるという効果を奏する。

以下に、本発明にかかるＷｅｂシステムマニュアル生成装置の実施の形態を図面に基づいて詳細に説明する。なお、この実施の形態によりこの発明が限定されるものではない。

図１は、この発明におけるＷｅｂシステムマニュアル生成装置が適用されるシステム、およびＷｅｂシステムマニュアル生成装置の構成を示す図である。図１において、Ｗｅｂシステムマニュアル生成装置１は、利用者が使用する端末（以下、クライアントという）２と、インターネットなどのネットワーク３を介して接続される。

Ｗｅｂシステムマニュアル生成装置１は、インターフェース部（以下、Ｉ／Ｆ部という）１１、入力情報処理部１２、データ格納ＤＢ１３、説明文パターン蓄積ＤＢ１４、および画面情報処理部１５を備えている。

Ｉ／Ｆ部１１は、ネットワーク３とのインターフェース機能を有し、ネットワーク３を介してクライアント２からのデータ受信や、クライアント２へのデータ送信を行う。入力情報処理部１２は、Ｉ／Ｆ部１１を介してクライアント２から受信した設計したＷｅｂシステムの設計結果であるプログラムや、ＨＴＭＬやＸＭＬなどのマークアップ言語で記載された画面定義データをデータ格納ＤＢ１３に格納する。

説明文パターン蓄積ＤＢ１４には、マニュアル生成に必要な説明文パターンなどが登録される。図２は、説明文パターン蓄積ＤＢ１４に登録される登録項目の一例を示す図である。図２においては、説明文パターン蓄積ＤＢ１４の登録項目として、タグの文字列が登録されるタグ文字列と、このタグ文字列に登録されたタグ文字列に対応付けて当該タグ文字列の説明文の基本となる基本説明文が登録される基本説明文、およびタグ文字列を識別するための識別情報（タグＩＤ）が登録されるタグＩＤとを挙げている。

図１に戻って、画面情報処理部１５は、データ格納ＤＢ１３に格納された画面定義データおよび説明文パターン蓄積ＤＢ１４に基づいてタグ情報を解析してタグに応じた説明文を作成するタグ情報処理部１５１と、タグ情報処理部１５１によって作成されたタグに応じた説明文およびデータ格納ＤＢ１３に格納された画面定義データに基づいて画面定義データによって表示される画面イメージとタグに応じた説明文とをマージして画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成する画面情報説明作成部１５２とを備えている。

タグ情報処理部１５１は、データ格納ＤＢ１３に格納された設計結果の画面定義データを検索してタグを抽出する画面定義タグ検索部１５１１と、画面定義タグ検索部１５１１によって抽出されたタグおよび説明文パターン蓄積ＤＢ１４に基づいて基本説明文およびタグＩＤを抽出する基本説明文抽出部１５１２と、基本説明文抽出部１５１２によって抽出されたタグＩＤに基づいて画面定義データから当該タグＩＤに応じた情報を抽出するタグ対応個別処理部１５１３と、基本説明文抽出部１５１２によって抽出された基本説明文およびタグ対応個別処理部１５１３によって抽出されたタグＩＤに応じた情報からタグに応じた説明文を作成するタグ説明文作成部１５１４とを備えている。

マニュアル生成／表示処理部１６は、画面情報処理部１５の画面情報説明作成部１５２によって作成された画面定義データ毎の画面説明データをまとめてマニュアルを生成し、生成したマニュアルをＩ／Ｆ部１１を介してクライアント２に送信してマニュアルを表示させる。

つぎに、図３のフローチャートを参照して、この発明のＷｅｂシステムマニュアル生成装置１の動作について説明する。利用者はクライアント２を用いて、作成すべきＷｅｂシステムのデータ、すなわちＷｅｂシステムの設計結果（１〜複数の画面定義データや、画面定義データ内で用いるＪａｖａ（登録商標）Ｓｃｒｉｐｔなどで記載されたプログラムなど）を送信する。

入力情報処理部１２は、Ｉ／Ｆ部１１を介して受信した設計結果（１〜複数の画面定義データや、画面定義データ内で用いるＪａｖａ（登録商標）Ｓｃｒｉｐｔなどで記載されたプログラムなど）をデータ格納ＤＢ１３に格納する（ステップＳ１００）。このとき、入力情報処理部１２は、１〜複数の画面定義データおよびプログラムを関連づけてデータ格納ＤＢ１３に登録する。

画面定義タグ検索部１５１１は、登録された画面定義データを検索して処理対象画面定義データを選択する（ステップＳ１０１）。処理の最初は、画面定義タグ検索部１５１１は、登録された画面定義データの中からシステムにおける最初のページの画面定義データを処理対象画面定義データとして選択する。

画面定義タグ検索部１５１１は、行カウンタ（ｉ）を初期化（ここでは、「ｉ＝１」に）する（ステップＳ１０２）。画面定義タグ検索部１５１１は、処理対象画面定義データのｉ行目のタグ情報を検索する（ステプＳ１０３）。

処理対象画面定義データのｉ行目にタグ情報を検出できなかった場合（ステップＳ１０４，Ｎｏ）、画面定義タグ検索部１５１１は、検索したｉ行が処理対象画面定義データの最終行であるか否か、すなわち処理対象画面定義データの最後まで検索したか否かを判定する（ステップＳ１０５）。処理対象画面定義データの最後ではない場合（ステップＳ１０５，Ｎｏ）、画面定義タグ検索部１５１１は、行カウンタをインクリメント（ｉ＝ｉ＋１）して処理対象画面定義データのｉ行のタグ情報を検出する動作を、タグ情報を検出するか、処理対象画面定義データの最後になるまで繰り返す（ステップＳ１０３〜Ｓ１０６）。

処理対象画面定義データのｉ行目にタグ情報を検出した場合（ステップＳ１０４，Ｙｅｓ）、画面定義タグ検索部１５１１は、検出したタグ情報を抽出する（ステップＳ１０７）。たとえば、図４に示した画面定義データを処理対象画面定義データとして選択した場合、画面定義タグ検索部１５１１は、「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｒｅｄ”＞赤」の行において、タグである「＜」と「＞」で囲まれた文字列「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｒｅｄ”」をタグ情報として検出して取得する。画面定義タグ検索部１５１１は、抽出したタグ情報を基本説明文抽出部１５１２に通知する。ここでは、画面定義タグ検索部１５１１は、「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｒｅｄ”」をタグ情報として基本説明文抽出部１５１２に通知する。

基本説明文抽出部１５１２は、画面定義タグ検索部１５１１から通知されたタグ情報が説明文パターン蓄積ＤＢ１４に登録されているか否かを判定する（ステップＳ１０８）。具体的には、基本説明文抽出部１５１２は、通知されたタグ情報のすべてまたは一部を検索キーとして、説明文パターン蓄積ＤＢ１４のタグ文字列を検索し、検索キーと一致するタグ文字列を抽出する。基本説明文抽出部１５１２は、検索キーと一致するタグ文字列を抽出した場合には、タグ情報が説明文パターン蓄積ＤＢ１４に登録されていると判定し、検索キーと一致するタグ文字列が抽出できなかった場合には、タグ情報が説明文パターン蓄積ＤＢ１４に登録されていないと判定する。

タグ情報が説明文パターン蓄積ＤＢ１４に登録されていない場合（ステップＳ１０８，Ｎｏ）、基本説明文抽出部１５１２は、たとえば、検索キーとしたタグ情報が説明文パターン蓄積ＤＢ１４に登録されていない旨を示すメッセージなどを表示部（図示せず）に表示するなどの所定の異常処理を実行して処理を終了する（ステップＳ１０９）。

タグ情報が説明文パターン蓄積ＤＢ１４に登録されている場合（ステップＳ１０８，Ｙｅｓ）、基本説明文抽出部１５１２は、検索キーと一致したタグ情報に関連づけて説明文パターン蓄積ＤＢ１４に登録されている基本説明文およびタグＩＤを取得する（ステップＳ１１０）。基本説明文抽出部１５１２は、取得した基本説明文およびタグＩＤをタグ対応個別処理部１５１３に通知する。

ここでは、画面定義タグ検索部１５１１から「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｒｅｄ”」が通知されている。よって、基本説明文抽出部１５１２は、タグ情報の中の「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ”」を検索キーとして説明文パターン蓄積ＤＢ１４のタグ文字列を検索する。そして、基本説明文抽出部１５１２は、説明文パターン蓄積ＤＢ１４のタグ文字列から「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ”」を抽出し、このタグ文字列に関連づけて説明文パターン蓄積ＤＢ１４に登録されている基本説明文「Ｘ１，Ｘ２，Ｘ３，・・・から選択してください。（複数選択可）」およびタグＩＤ「４」を取得してタグ対応個別処理部１５１３に通知する。

タグ対応個別処理部１５１３は、基本説明文抽出部１５１２から通知された基本説明文およびタグＩＤに基づいてタグ説明文作成部１５１４とともに説明文作成処理を実行する（ステップＳ１１１）。タグ対応個別処理部１５１３およびタグ説明文作成部１５１４が実行する説明文作成処理は、タグ情報とともに画面定義データに登録されているラベルやコメント、関連プログラムに登録されているコメントを抽出し、抽出したラベルやコメントに基づいて基本説明文を完成させる処理である。

具体的には、先の図２に示した説明文パターン蓄積ＤＢ１４においては、タグ文字列「ａ ｈｒｅｆ」に関連付けられた基本説明文は「リンクを押下すると、Ｘへ遷移します。」であり、タグ文字列「ｉｎｐｕｔ ｔｙｐｅ＝”ｔｅｘｔ”」に関連づけられた基本説明文は「Ｘ欄に入力してください。」であり、タグ文字列「ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”」に関連付けられた基本説明文は「Ｘ１，Ｘ２，Ｘ３，・・・から一つ選択してください。」であり、タグ文字列「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ”」に関連付けられた基本説明文は「Ｘ１，Ｘ２，Ｘ３，・・・から選択してください。（複数選択可）」であり、タグ文字列「ｓｅｌｃｅｔ ｎａｍｅ」に関連付けられた基本説明文は「プルダウンの中から一つ選択してください。」である。説明文作成処理は、これらの基本説明文の不確定要素「Ｘ」や「Ｘ１」、「Ｘ２」、「Ｘ３」、・・・に対応する文字列（ラベルやコメント）を抽出して基本説明文を完成させる。

ここでは、基本説明文抽出部１５１２から基本説明文「Ｘ１，Ｘ２，Ｘ３，・・・から選択してください。（複数選択可）」およびタグＩＤ「４」が通知されている。したがって、説明文作成処理としてタグＩＤ「４」に応じた処理が実行される。

図５のフローチャートを参照して、タグＩＤ「４」に対応する処理を詳細に説明する。タグ対応個別処理部１５１３は、現在行（ｉ行）において画面定義タグ検索部１５１１が取得したタグ情報、すなわち通知されたタグＩＤに関連付けられて説明文パターン蓄積ＤＢ１４のタグ文字列に登録されている文字列の要素（この場合は、「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ”」）のｎａｍｅ属性が同一のタグ情報が記載されている行を処理対象画面定義データの現在行以降からすべて抽出する（ステップＳ２００）。

先の図４においては、タグ対応個別処理部１５１３は、「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｒｅｄ”＞赤」、＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｗｈｉｔｅ”＞白」、＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｙｅｌｌｏｗ”＞黄」、および「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｐｉｎｋ”＞ピンク」の行を抽出する。

タグ対応個別処理部１５１３は、抽出した各行のタグ情報の後に続く文字列（ラベル）を取得する（ステップＳ２０１）。ここでは、タグ対応個別処理部１５１３は、「赤」、「白」、「黄」、および「ピンク」を取得する。

タグ対応個別処理部１５１３は、抽出したすべての行を対象としてコメントが記載されているか否かを判定する（ステップＳ２０２）。コメントが記載されている場合（ステップＳ２０２，Ｙｅｓ）、タグ対応個別処理部１５１３は、記載されているコメントを取得する（ステップＳ２０３）。

タグ対応個別処理部１５１３は、取得したコメントに基づいて関連プログラムが存在するか否かを判定する（ステップＳ２０４）。関連プログラムが存在する場合（ステップＳ２０４，Ｙｅｓ）、タグ対応個別処理部１５１３は、データ格納ＤＢ１３から関連プログラムを読み出して、読み出した関連プログラムを検索して処理内容を取得する（ステップＳ２０５）。

タグ対応個別処理部１５１３は、取得した各種情報をタグ説明文作成部１５１４に通知する。具体的には、コメントが記載されていない場合（ステップＳ２０２，Ｎｏ）、タグ対応個別処理部１５１３は、ステップＳ２０１において取得したラベル、および基本説明文抽出部１５１２から通知された基本説明文をタグ説明文作成部１５１４に通知する。

コメントが記載されており（ステップＳ２０２，Ｙｅｓ）、かつ関連プログラムが存在しない場合（ステップＳ２０４，Ｎｏ）、タグ対応個別処理部１５１３は、ステップＳ２０１において取得したラベル、ステップＳ２０３において取得したコメント情報、および基本説明文抽出部１５１２から通知された基本説明文をタグ説明文作成部１５１４に通知する。

コメントが記載されており（ステップＳ２０２，Ｙｅｓ）、かつ関連プログラムが存在する場合（ステップＳ２０４，Ｙｅｓ）、タグ対応個別処理部１５１３は、ステップＳ２０１において取得したラベル、ステップＳ２０３において取得したコメント情報、ステップＳ２０５において取得した処理内容、および基本説明文抽出部１５１２から通知された基本説明文をタグ説明文作成部１５１４に出力する。

図４においては、ステップＳ２００において抽出した「ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ”ｎａｍｅ＝”ｃｏｌｏｒ”」を含む各行にはコメントが記載されていない。よって、タグ対応個別処理部１５１３は、ステップＳ２０１において取得したラベル「赤」、「白」、「黄」、および「ピンク」と、基本説明文「Ｘ１，Ｘ２，Ｘ３，・・・から選択してください。（複数選択可）」をタグ説明文作成部１５１４に出力する。

タグ説明文作成部１５１４は、タグ対応個別処理部１５１３からの通知に基づいて説明文を作成する（ステップＳ２０６）。この場合は、タグ説明文作成部１５１４は、通知されたラベルを基本説明文の「Ｘ１，Ｘ２，Ｘ３，・・・」に当てはめて「「赤」、「白」、「黄」、「ピンク」から選択してください。（複数選択可）」という説明文を作成する。タグ説明文作成部１５１４は、作成した説明文を画面情報説明作成部１５２に通知してタグＩＤ［４」に対応する処理を終了する。

図３に戻って、説明文作成処理によって作成された説明文が通知されると、画面情報説明作成部１５２は、通知された説明文をデータ格納ＤＢ１３に格納する（ステップＳ１１２）。ここでは、画面情報説明作成部１５２は、「「赤」、「白」、「黄」、「ピンク」から選択してください。（複数選択可）」という説明文をデータ格納ＤＢ１３に格納する。

一方、説明文作成処理が終了すると、画面定義タグ検索部１５１１は、つぎのタグ情報の検索を開始する（ステップＳ１１３）。ここで、上述した説明文作成処理によって、先の図４に示した画面定義データ（処理対象画面定義データ）の「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｐｉｎｋ”＞ピンク」の行までの処理が終了している。よって、画面定義タグ検索部１５１１は、行カウンタ（ｉ）をインクリメントするのではなく、「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｃｈｅｃｋｂｏｘ” ｎａｍｅ＝”ｃｏｌｏｒ” ｖａｌｕｅ＝”ｐｉｎｋ”＞ピンク」のつぎの行に設定し、処理対象画面定義データのｉ行目にタグ情報が存在するか否かを判定するステップＳ１０４に戻って、処理対象画面定義データのｉ行目にタグ情報が存在するか否かを判定し、行カウンタをインクリメント（ｉ＝ｉ＋１）して処理対象画面定義データのｉ行のタグ情報を検出する動作を、タグ情報を検出するか、処理対象画面定義データの最後になるまで繰り返す（ステップＳ１０４〜Ｓ１０６）。

ここでは、図４に示した画面定義データが処理対象画面定義データであるので、画面定義タグ検索部１５１１は、「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”〜ｏｎＣｌｉｃｋ＝〜＞あいう ＜！−−「あいう」を選択するとＡＢです。−−＞」の行において、「ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ” 〜ｏｎＣｌｉｃｋ＝〜」をタグ情報として検出して取得する（ステップＳ１０４，Ｓ１０７）。そして、基本説明文抽出部１５１２は、説明文パターン蓄積ＤＢ１４から基本説明文「Ｘ１，Ｘ２，Ｘ３・・・から一つ選択してください。」とタグＩＤ「３」を取得する（ステップＳ１０８，Ｓ１１０）。

タグ対応個別処理部１５１３およびタグ説明文作成部１５１４は、タグＩＤ「３」に対応した説明文作成処理を実行する（ステップＳ１１１）。ここでは、タグ対応個別処理部１５１３は、タグ情報「ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”〜ｏｎＣｌｉｃｋ＝〜」が記載されている「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”〜ｏｎＣｌｉｃｋ＝〜＞あいう ＜！−−「あいう」を選択するとＡＢです。−−＞」および「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”〜ｏｎＣｌｉｃｋ＝〜＞いう ＜！−−「いう」を選択するとＢＣです。−−＞」の行を抽出し、抽出した行のタグ情報に後に続く文字列（ラベル）として、「あいう」および「いう」を取得する。また、コメントとして「「あいう」を選択するとＡＢです。」および「「いう」を選択するとＢＣです。」を取得する。

タグ説明文作成部１５１４は、タグ対応個別処理部１５１３が取得したラベルおよびコメントと、基本説明文に基づいて、「「あいう」、「いう」から一つ選択してください」、「「あいう」を選択するとＡＢです。」、および「「いう」を選択するとＢＣです。」という３つの説明文を作成してタグＩＤ「３」に対応した説明文作成処理を終了する。

画面情報説明作成部１５２は、タグ対応個別処理部１５１３およびタグ説明文作成部１５１４によって実行された説明文作成処理によって作成された説明文をデータ格納ＤＢ１３に格納し（ステップＳ１１２）、画面定義タグ検索部１５１１は、つぎのタグ情報の検索を開始する（ステップＳ１１３）。ここでは、行カウンタ（ｉ）は、「＜ｉｎｐｕｔ ｔｙｐｅ＝”ｒａｄｉｏ”〜ｏｎＣｌｉｃｋ＝〜＞いう ＜！−−「いう」を選択するとＢＣです。−−＞」のつぎの行に設定される。

画面定義タグ検索部１５１１は、つぎに「あいう＜ｉｎｐｕｔ ｔｙｐｅ＝”ｔｅｘｔ”ｓｉｚｅ＝”３０”＞＜！−−Ｃｌａｓｓ（Ａｂｃ）。ｃｈｅｃｋＡｂｃＳｉｚｅ（）−−＞」の行において「ｉｎｐｕｔ ｔｙｐｅ＝”ｔｅｘｔ”ｓｉｚｅ＝” ＝”３０”」をタグ情報として検出して取得する（ステップＳ１０４，Ｓ１０７）。そして、基本説明文抽出部１５１２は、説明文パターン蓄積ＤＢ１４から基本説明文「Ｘ欄に入力してください。」とタグＩＤ「２」を取得する（ステップＳ１０８，Ｓ１１０）。

タグ対応個別処理部１５１３およびタグ説明文作成部１５１４は、タグＩＤ「２」に対応した説明文作成処理を実行する（ステップＳ１１１）。ここでは、タグ対応個別処理部１５１３は、タグ情報「ｉｎｐｕｔ ｔｙｐｅ＝”ｔｅｘｔ”ｓｉｚｅ＝” ＝”３０”」の前に記載されている文字列（ラベル）として、「あいう」を取得する。また、コメントとして、「＜！−−Ｃｌａｓｓ（Ａｂｃ）．ｃｈｅｃｋＡｂｃＳｉｚｅ（）−−＞」を取得する。このコメントは、関連プログラムが「Ｃｌａｓｓ（Ａｂｃ）」および「ｃｈｅｃｋＡｂｃＳｉｚｅ（）」存在することを示している。よって、タグ対応個別処理部１５１３は、関連プログラムである「Ｃｌａｓｓ（Ａｂｃ）」および「ｃｈｅｃｋＡｂｃＳｉｚｅ（）」が記載されているプログラムファイルをデータ格納ＤＢ１３から読み出す。そして、タグ対応個別処理部１５１３は、読み出した関連プログラムファイルを検索して関連プログラムの処理内容の記載を取得する。

図６は、関連プログラム「Ｃｌａｓｓ（Ａｂｃ）」および「ｃｈｅｃｋＡｂｃＳｉｚｅ（）」が記載されているプログラムファイルの一例を示す図である。図６に示すように、関連プログラムとして画面定義データのコメントに記載されるプログラムには、プログラムの処理内容をコメントとして記載しておく。すなわち、Ｗｅｂシステムの設計者は、本装置を用いてマニュアルを生成することを意識して、画面定義データおよびプログラム内に、マニュアルに必要な記載をコメントとして記載しておく。ここでは、処理内容として、「あいう欄に入力された文字列が２０文字以上の場合、エラー画面が表示されます。」が記載されている。タグ対応個別処理部１５１３は、このコメントを取得する。

タグ説明文作成部１５１４は、タグ対応個別処理部１５１３が取得したラベルおよびコメントと、基本説明文に基づいて、「あいう欄に入力してください。」および「あいう欄に入力された文字列が２０文字以上の場合、エラー画面が表示されます。」という２つの説明文を作成してタグＩＤ「２」に対応した説明文作成処理を終了する。

画面情報説明作成部１５２は、タグ対応個別処理部１５１３およびタグ説明文作成部１５１４によって実行された説明文作成処理によって作成された説明文をデータ格納ＤＢ１３に格納し（ステップＳ１１２）、画面定義タグ検索部１５１１は、つぎのタグ情報の検索を開始する（ステップＳ１１３）。こでは、行カウンタ（ｉ）は、「あいう＜＜ｉｎｐｕｔ ｔｙｐｅ＝”ｔｅｘｔ”ｓｉｚｅ＝”３０”＞＜！−−Ｃｌａｓｓ（Ａｂｃ）。ｃｈｅｃｋＡｂｃＳｉｚｅ（）−−＞」のつぎの行に設定される。

このようにして、処理対象画面定義データの最後の行までタグ情報の検索が終了すると（ステップＳ１０５，Ｙｅｓ）、画面情報説明作成部１５２は、ブラウザを用いて処理対象画面定義データから作成される表示画面、すなわち処理対象画面定義データの画面イメージを取得する（ステップＳ１１４）。

画面情報説明作成部１５２は、処理対象画面定義データから作成された説明文をすべてデータ格納ＤＢ１３から取得する。画面情報説明作成部１５２は、取得した画面イメージと各タグ情報によって表示される画面の説明文とをマージして、処理対象画面定義データに対する画面説明データを作成する（ステップＳ１１５）。

図７は、先の図４に示した画面定義データを処理対象画面定義データとした場合に画面情報説明作成部１５２が作成する画面説明データの表示画面の一例を示す図である。図７に示すように、画面情報説明作成部１５２は、処理対象画面定義データの画面イメージ５１を表示画面５の所定の領域に配置し、各説明文を表示画面の所定の領域５２に表示する画面説明データを作成する。ここでは、領域５２には、処理対象画面定義データの画面イメージ５１の領域５１１のチェックボックスの説明文「「赤」、「白」、「黄」、「ピンク」から選択してください。（複数選択可）」と、処理対象画面定義データの画面イメージ５１の領域５１２のラジオボタンの説明文「「あいう」、「いう」から一つ選択してください」、「「あいう」を選択するとＡＢです。」、および「「いう」を選択するとＢＣです。」と、処理対象画面定義データの画面イメージ５１の領域５１３の文字入力欄の説明文「あいう欄に入力してください。」および「あいう欄に入力された文字列が２０文字以上の場合、エラー画面が表示されます。」を表示するようにしている。

画面情報説明作成部１５２は、作成した画面説明データをデータ格納ＤＢ１３に格納する（ステップＳ１１６）。これにより、処理対象画面定義データに対する処理が終了する。このように、画面情報処理部１５は、クライアント２によってデータ格納ＤＢ１３に格納された画面定義データを検索して処理対象画面定義データを選択し、選択した処理対象画面定義データに対して、タグ情報を検出し、検出したタグ情報に関連付けられて説明文パターン蓄積ＤＢ１４に登録されている基本説明文およびタグＩＤを取得し、取得したタグＩＤに対応した説明文作成処理を実行して説明文を作成し、作成した説明文と処理対象画面定義データの画面イメージとに基づいて画面説明データを生成する動作を、未処理の画面定義データがなくなるまで繰り返す（ステップＳ１０１〜Ｓ１１７）。

未処理の画面定義データがなくなると（ステップＳ１１７，Ｎｏ）、マニュアル生成／表示処理部１６は、画面情報説明作成部１５２によってデータ格納ＤＢ１３に格納された画面説明データをすべて読み出し、読み出した画面説明データをＷｅｂシステムのマニュアルとしてまとめて表示データを生成し、生成した表示データをＩ／Ｆ部１１を介して送信し、クライアント２に表示させる（ステップＳ１１８）。

以上説明したように、この実施の形態においては、Ｗｅｂシステムの設計結果である該Ｗｅｂシステムのページの表示画面を定義した画面定義データに記述されたタグ情報の中から関連するタグ情報を抽出し、抽出したタグ情報に対応する基本説明文に基づいて当該タグ情報によって表示される表示画面の説明文を生成し、生成した説明文と画面定義データによって表示されるページの画面イメージとをマージして当該画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成し、作成したページ毎の画面説明データをＷｅｂシステムのマニュアルとしてまとめて表示されるようにしている。

これにより、新たにシステムの仕様を記述することなく、システムの設計結果を入力としてマニュアルを生成することができ、マニュアル作成の手間と時間を短縮することができる。

また、この実施の形態においては、基本説明文の中に不確定要素が存在する場合には、抽出したタグ情報に関するラベルを画面定義データから取得し、取得したラベルを基本説明文の不確定要素と置き換えて説明文を作成するようにしているため、新たにシステムの仕様を記述することなく、システムの設計結果を入力としてマニュアルを生成することができ、マニュアル作成の手間と時間を短縮することができる。

さらに、この実施の形態においては、抽出したタグ情報に関連するコメントが画面定義データに記述されている場合には、当該コメントの記述を取得して基本説明文とともに取得したコメントの記述を当該タグ情報によって表示される表示画面の説明文とするようにしているため、システム設計時に設計者が、マニュアルを作成することを意識して説明に必要な記載をコメントとして記述しておくだけで、システムの設計結果を入力としてマニュアルを生成することができ、マニュアル作成の手間と時間を短縮することができる。また、設計者によってバラツキが生じていた画面定義データの記述方法を統一することができる。

さらにまた、この実施の形態においては、抽出したタグ情報に関連するコメントが関連するプログラムを示している場合には、該コメントが示すプログラムが記述されたプログラムファイルの中からコメントの記述を取得して基本説明文とともに取得したコメントの記述を当該タグ情報によって表示される表示画面の説明文とするようにしているため、システム設計時に設計者が、マニュアルを作成することを意識して説明に必要な記載をコメントとして記述（たとえば、画面定義データにプログラムの情報としてクラス名やメソッド名などをコメントとして記述し、当該プログラムが記述されたプログラムファイルにその処理内容のコメントを記述する）しておくだけで、システムの設計結果を入力としてマニュアルを生成することができ、マニュアル作成の手間と時間を短縮することができる。また、設計者によってバラツキが生じていた画面定義データの記述方法を統一することができる。

なお、この実施の形態におけるＩ／Ｆ部１１、入力情報処理部１２、画面定義タグ検索部１５１１、基本説明文抽出部１５１２、タグ対応個別処理部１５１３、タグ説明文作成部１５１４、画面情報説明作成部１５２、およびマニュアル生成／表示処理部１６によって実現される前述した各機能を、汎用のコンピュータに実行させるためのＷｅｂシステムマニュアル生成プログラムとして提供してもよい。この場合、Ｗｅｂシステムマニュアル生成プログラムは、コンピュータにインストール可能な形式、またはコンピュータが実行可能な形式のファイルでＣＤ−ＲＯＭ、フロッピー（登録商標）ディスク、ＤＶＤなどのコンピュータで読み取り可能な記録媒体に記録して提供する。記録媒体に記録されたＷｅｂシステムマニュアル生成プログラムは、記録媒体から読み出されてコンピュータ上で実現される。

Ｗｅｂシステムマニュアル生成プログラムを実行するコンピュータは、少なくとも制御装置と、記憶装置とを備えている。制御装置は、コンピュータ全体を制御するＣＰＵなどの演算処理装置と、ＲＯＭとを備えている。記憶装置は、一般的なＲＡＭで構成され、データ格納ＤＢ１３および説明文パターン蓄積ＤＢ１４として用いられる。なお、説明文パターン蓄積ＤＢ１４の格納にはＲＯＭを用いてもよい。制御装置は、Ｗｅｂシステムマニュアル生成プログラムが記録されている記録媒体からＷｅｂシステムマニュアル生成プログラムを読み出して実行することで、Ｉ／Ｆ部１１、入力情報処理部１２、画面定義タグ検索部１５１１、基本説明文抽出部１５１２、タグ対応個別処理部１５１３、タグ説明文作成部１５１４、画面情報説明作成部１５２、およびマニュアル生成／表示処理部１６によって実現される前述した各機能としてコンピュータを動作させる。

また、Ｗｅｂシステムマニュアル生成プログラムをネットワークに接続されたコンピュータ上に格納し、ネットワークを介してダウンロードさせることにより提供するように構成してもよい。また、Ｗｅｂシステムマニュアル生成プログラムをネットワークを介して提供または配布するように構成してもよい。

以上のように、本発明にかかるＷｅｂシステムマニュアル生成装置は、Ｗｅｂシステムのマニュアルの作成に有用であり、特に、条件や機能の多いＷｅｂシステムのマニュアルの作成に適している。

この発明におけるＷｅｂシステムマニュアル生成装置が適用されるシステム、およびＷｅｂシステムマニュアル生成装置の構成を示す図である。 図１に示した説明文パターン蓄積ＤＢに登録される登録項目の一例を示す図である。 この発明のＷｅｂシステムマニュアル生成装置の動作を説明するためのフローチャートである。 画面定義データの一例を示す図である。 タグＩＤ［４」に対応する説明文作成処理の動作を説明するためのフローチャートである。 関連プログラムファイルの一例を示す図である。 画面説明データの表示画面の一例を示す図である。

符号の説明

１ Ｗｅｂシステムマニュアル生成装置
２ クライアント
３ ネットワーク
５ 表示画面
１１ Ｉ／Ｆ部
１２ 入力情報処理部
１３ データ格納ＤＢ
１４ 説明文パターン蓄積ＤＢ
１５ 画面情報処理部
１６ マニュアル生成／表示処理部
５１ 画面イメージ
５２，５１１，５１２，５１３ 領域
１５１ タグ情報処理部
１５１１ 画面定義タグ検索部
１５１２ 基本説明文抽出部
１５１３ タグ対応個別処理部
１５１４ タグ説明文作成部

Claims (4)

1. Ｗｅｂシステムの設計結果である該Ｗｅｂシステムのページの表示画面を定義した画面定義データ、および該画面定義データで用いられるプログラムが記述されたプログラムファイルに基づいて前記Ｗｅｂシステムのマニュアルを生成するＷｅｂシステムマニュアル生成装置であって、
   前記画面定義データを記述する言語の各タグ情報に対応付けて当該タグ情報における表示の基本説明文が登録される説明文パターン蓄積データベースと、
   前記画面定義データに記述されたタグ情報の中から関連するタグ情報を抽出し、抽出したタグ情報に対応付けて前記説明文パターン蓄積データベースに登録されている基本説明文に基づいて当該タグ情報によって表示される表示画面の説明文を生成するタグ情報処理部と、
   前記タグ情報処理部によって生成された説明文と前記画面定義データによって表示されるページの画面イメージとをマージして当該画面定義データによって表示される画面を説明する情報を定義した画面説明データを作成する画面情報説明作成部と、
   前記画面情報説明作成部によって作成された前記Ｗｅｂシステムのページ毎の画面説明データをマニュアルとしてまとめて表示させるマニュアル生成／表示処理部と、
   を備えることを特徴とするＷｅｂシステムマニュアル生成装置。
2. 前記タグ情報処理部は、
   抽出したタグ情報に対応付けて前記説明文パターン蓄積データベースに登録されている基本説明文の中に不確定要素が存在する場合には、抽出したタグ情報に関連するラベルを前記画面定義データから取得し、取得したラベルを前記基本説明文の不確定要素と置き換えて説明文を作成すること、
   を特徴とする請求項１に記載のＷｅｂシステムマニュアル生成装置。
3. 前記タグ情報処理部は、
   抽出したタグ情報に関連するコメントが前記画面定義データに記述されている場合には、当該コメントの記述を取得して基本説明文とともに取得したコメントの記述を当該タグ情報によって表示される表示画面の説明文とすること、
   を特徴とする請求項１または２に記載のＷｅｂシステムマニュアル生成装置。
4. 前記タグ情報処理部は、
   抽出したタグ情報に関連するコメントが関連するプログラムを示している場合には、該コメントが示すプログラムが記述されたプログラムファイルの中からコメントの記述を取得して基本説明文とともに取得したコメントの記述を当該タグ情報によって表示される表示画面の説明文とすること、
   を特徴とする請求項１〜３のいずれか一つに記載のＷｅｂシステムマニュアル生成装置。

Images