JP2017021479A - マニュアル生成装置、マニュアル生成システム、マニュアル生成方法、及びマニュアル生成プログラム - Google Patents

Abstract

【課題】ＣＬＩを介して操作される情報処理装置のマニュアルの作成を効率化する。【解決手段】コマンドラインインタフェースを介して操作される情報処理装置の、コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、コマンドラインインタフェースを介して情報処理装置から取得するコマンド情報取得手段と、コマンド情報に基づいて、コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成手段とを備える。【選択図】 図１

Description

本発明は、コマンドラインインタフェース（ＣＬＩ：Command Line Interface）を介して操作される情報処理装置のコマンドマニュアル（以下、単に「マニュアル」という）を生成するマニュアル生成装置、マニュアル生成システム、マニュアル生成方法、及びマニュアル生成プログラムに関する。

ＣＬＩを介して操作される情報処理装置では、コマンドの種類が多く、コマンドが複雑であることが多い。そのため、情報処理装置の操作が行われる際には、マニュアルが必要である。しかしながら、情報処理装置のバージョンが古く、対応するマニュアルの入手が困難である場合や、情報処理装置のバージョンとマニュアルのバージョンが一致していない場合等、適切なマニュアルを利用できない場合がある。マニュアルを利用せずに情報処理装置の操作が行われる場合には、作業者の負担が多く、また、情報処理装置の操作ミスが発生しやすい。そこで、マニュアルの作成を効率化する技術が開発されている。

マニュアル生成技術の一例が、特許文献１に開示されている。特許文献１の接続機器情報生成装置は、以下のように動作する。まず、接続機器情報生成装置は、接続機器から、接続機器の機種又は実装されたオプション機能を示す仕様情報を取得する。次に、接続機器情報生成装置は、取得した仕様情報と、機種又はオプション機能に対応するマニュアルの部分を示す関連付け情報に基づいて、接続機器の機種又は実装されたオプション機能に対応するマニュアルの部分を抽出したマニュアルを生成する。上記の動作の結果、特許文献１の接続機器情報生成装置は、接続機器の機種又は実装されたオプション機能に対応するマニュアルの部分を抽出したマニュアルを生成する。

マニュアル生成技術の別の一例が、特許文献２に開示されている。特許文献２の情報処理装置は、以下のように動作する。情報処理装置のコマンド実行部は、共通フォーマットファイルのコマンド実行情報に基づいて、コマンドの実行を行う。また、情報処理装置のマニュアル作成部は、共通フォーマットファイルに基づいて、マニュアルの作成を行う。上記の動作の結果、特許文献２の情報処理装置は、特定のバージョンのコマンドに対応したマニュアルを作成する。

ＷＯ２００８／０５０４３８号公報 ＷＯ２００７／１４１８３７号公報

しかしながら、特許文献１のマニュアル生成技術では、機種又はオプション機能に対応するマニュアルの部分が予め用意される必要がある。また、特許文献２のマニュアル生成技術では、コマンドの仕様は、共通フォーマットファイルとして予め用意される必要がある。そのため、特許文献１及び特許文献２のマニュアル生成技術では、マニュアルを生成する元となる情報の作成のために工数が必要であるという問題点がある。
（発明の目的）
本発明の主たる目的は、ＣＬＩを介して操作される情報処理装置のマニュアルの作成を効率化することができるマニュアル生成装置、マニュアル生成システム、マニュアル生成方法、及びマニュアル生成プログラムを提供することにある。

本発明のマニュアル生成装置は、コマンドラインインタフェースを介して操作される情報処理装置の、コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、コマンドラインインタフェースを介して情報処理装置から取得するコマンド情報取得手段と、コマンド情報に基づいて、コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成手段と、を備えることを特徴とする。

本発明のマニュアル生成システムは、コマンドラインインタフェースを介して操作される情報処理装置とマニュアル生成装置と、を備え、マニュアル生成装置は、情報処理装置の、コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、コマンドラインインタフェースを介して情報処理装置から取得するコマンド情報取得手段、並びに、コマンド情報に基づいて、コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成手段、を備えることを特徴とする。

本発明のマニュアル生成方法は、コマンドラインインタフェースを介して操作される情報処理装置の、コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、コマンドラインインタフェースを介して情報処理装置から取得し、コマンド情報に基づいて、コマンドの利用方法が説明されたマニュアルを生成することを特徴とする。

本発明のマニュアル生成プログラムは、コマンドラインインタフェースを介して操作される情報処理装置の、コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、コマンドラインインタフェースを介して情報処理装置から取得するコマンド情報取得処理と、コマンド情報に基づいて、コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成処理と、をコンピュータに実行させることを特徴とする。

本発明によれば、ＣＬＩを介して操作される情報処理装置のマニュアルの作成を効率化することができるという効果がある。

本発明の第１の実施形態のマニュアル生成装置の構成の一例を示すブロック図である。 本発明の第１の実施形態のマニュアル生成装置の動作を示すフローチャートである。 本発明の第１の実施形態のマニュアル生成装置の処理の具体例を説明するための図である。 本発明の第２の実施形態のマニュアル生成装置の構成の一例を示すブロック図である。 本発明の第２の実施形態のマニュアル生成装置の動作を示すフローチャートである。 本発明の第２の実施形態のマニュアル生成装置の処理の具体例を説明するための図である。 本発明の第２の実施形態のマニュアル生成装置の処理の具体例を説明するための図である。 本発明の第３の実施形態のマニュアル生成装置の構成の一例を示すブロック図である。 本発明の第３の実施形態のマニュアル生成装置の動作を示すフローチャートである。 本発明の第３の実施形態のマニュアル生成装置の処理の具体例を説明するための図である。

以下、本発明の実施形態について、図面を参照して詳細に説明する。なお、すべての図面において、同等の構成要素には同じ符号を付し、適宜説明を省略する。
（第１の実施形態）
まず、以下の説明で使用される用語について説明する。

「コマンドリスト情報」とは、入力可能なＣＬＩコマンドの名称のリストの情報である。コマンドリスト情報は、各ＣＬＩコマンドの概要説明等を更に含んでもよい。

「コマンド個別情報」とは、特定のＣＬＩコマンドの利用方法に関する情報である。コマンド個別情報は、例えば、特定のＣＬＩコマンドにおいて指定可能なパラメータの、名称又は説明である。

「コマンド情報」とは、ＣＬＩコマンドの利用方法に関する情報である。コマンドリスト情報及びコマンド個別情報は、コマンド情報の一種である。

「コマンドリスト情報取得コマンド」とは、コマンドリスト情報を取得するためのＣＬＩコマンドである。コマンドリスト情報取得コマンドを示す文字列には、“help”、“？”等が使用される。

「コマンド個別情報取得コマンド」とは、コマンド個別情報を取得するためのＣＬＩコマンドである。コマンド個別情報取得コマンドを示す文字列には、“help”、“？”等が使用され、“help cmd”、“cmd ？”等（“cmd”はコマンドの名称）のように対象であるＣＬＩコマンドが指定される。

「コマンド情報取得コマンド」とは、コマンドリスト情報を取得するためのＣＬＩコマンドである。コマンドリスト情報取得コマンド及びコマンド個別情報取得コマンドは、コマンド情報取得コマンドの一種である。コマンド情報取得コマンドの機能は、「コマンドヘルプ」とも呼ばれる。

以上が、用語についての説明である。

本実施形態における構成について説明する。

図１は、本発明の第１の実施形態のマニュアル生成装置１００の構成の一例を示すブロック図である。

まず、マニュアル生成装置１００を含むマニュアル生成システム５００の構成について説明する。マニュアル生成システム５００は、情報処理装置２００とマニュアル生成装置１００とを含む。情報処理装置２００とマニュアル生成装置１００とは、ＣＬＩを介して通信を行う。なお、マニュアル生成装置１００は情報処理装置２００をＣＬＩを介して操作できればよく、マニュアル生成装置１００と情報処理装置２００との間の接続方式は任意の接続方式であってよい。マニュアル生成装置１００と情報処理装置２００との間の接続方式は、例えば、シリアルポート（RS-232）、ＵＳＢ（Universal Serial Bus）、ＩＥＥＥ（Institute of Electrical and Electronics Engineers）１３９４、各種のＬＡＮ（Local Area Network）、パラレルポート（ＩＥＥＥ１２８４）等の通信規格に従う接続方式である。また、マニュアル生成装置１００と情報処理装置２００が、プログラムである場合には、マニュアル生成装置１００と情報処理装置２００との間の接続方式は、プロセス間通信であってもよい。

情報処理装置２００は、ＣＬＩにより操作される情報処理装置である。情報処理装置２００は、例えば、通信機器、入出力機器、記憶装置、コンピュータである。情報処理装置２００は、ＣＬＩ手段２１０を含む。ＣＬＩ手段２１０は、ＣＬＩのコマンドを入力して、コマンドに対応する操作を行い、コマンドに対するＣＬＩのレスポンスを出力する。特に、ＣＬＩ手段２１０は、コマンド情報取得コマンドを入力して、コマンド情報を出力する。

マニュアル生成装置１００は、ＣＬＩを介して情報処理装置２００のコマンド情報を取得し、コマンド情報に基づいてマニュアルを生成する。マニュアル生成装置１００は、コマンド情報の取得やマニュアルの生成以外の機能を含んでもよい。例えば、マニュアル生成装置１００は、情報処理装置２００のコンソールとしての機能を含んでもよい。マニュアル生成装置１００は、コマンド情報取得手段１２０と、マニュアル生成手段１４０とを含む。

コマンド情報取得手段１２０は、情報処理装置２００へコマンド情報取得コマンドを出力し、情報処理装置２００からコマンド情報を入力する。

マニュアル生成手段１４０は、コマンド情報取得手段１２０により取得されたコマンド情報に基づいてマニュアルを生成する。

次に、本実施形態における動作について説明する。

図２は、本発明の第１の実施形態のマニュアル生成装置１００の動作を示すフローチャートである。なお、図２に示されるフローチャート及び以下の説明は一例であり、適宜求める処理に応じて、処理順等を入れ替えたり、処理を戻したり、又は処理を繰り返したりしてもよい。

コマンド情報取得手段１２０は、情報処理装置２００からＣＬＩを介してコマンドリスト情報を取得する（ステップＳ１１０）。

コマンド情報取得手段１２０は、情報処理装置２００からＣＬＩを介してコマンド個別情報を取得する（ステップＳ１２０）。

マニュアル生成手段１４０は、情報処理装置２００により取得されたコマンド情報に基づいてマニュアルを生成する（ステップＳ１３０）。

次に、本実施形態における処理の具体例について説明する。なお、本実施形態ではコマンド情報取得コマンドを示す文字列は限定されないが、本具体例では、コマンド情報取得コマンドを示す文字列として“help”を例に説明する。情報処理装置２００のＣＬＩ手段２１０は、コマンドリスト情報取得コマンド“help”に対して、コマンドの名称を含むコマンドリスト情報を返す。情報処理装置２００のＣＬＩ手段２１０は、コマンド個別情報取得コマンド“help CMD”（“CMD”はコマンドの名称）に対して、コマンドの説明を含むコマンド個別情報を返す。

図３は、本発明の第１の実施形態のマニュアル生成装置１００の処理の具体例を説明するための図である。

マニュアル生成装置１００は、コマンドリスト情報取得コマンド８１１を使用して、情報処理装置２００からコマンドリスト情報８２１を取得する（ステップＳ１１０）。コマンドリスト情報取得コマンド８１１は、文字列“help”のみを含む。取得したコマンドリスト情報８２１には、コマンドの名称の一覧が含まれる。

マニュアル生成装置１００は、コマンドリスト情報８２１から各コマンドの名称を抽出し、コマンド個別情報取得コマンド８１２、８１３を使用して、情報処理装置２００からコマンド個別情報８２２、８２３を取得する（ステップＳ１２０）。具体的には、マニュアル生成装置１００は、コマンドの名称として“CMD1”、“CMD2”を抽出する。また、マニュアル生成装置１００は、コマンド個別情報として“explanation-1”、“explanation-2”を取得する。なお、余分な、文字列、区切り文字、空白、改行等は、抽出結果及び取得結果から除外される。

マニュアル生成装置１００は、コマンド毎に、コマンドの名称とコマンド個別情報とを含む、マニュアル８４１を生成する（ステップＳ１３０）。具体的には、マニュアル生成装置１００は、１行目にコマンド“CMD1”の名称“CMD1”を、２行目にコマンド“CMD1”の説明“explanation-1”を含む、マニュアル８４１を生成する。同様に、マニュアル生成装置１００は、４行目にコマンド“CMD2”の名称“CMD2”を、５行目にコマンド“CMD2”の説明“explanation-2”を含む、マニュアル８４１を生成する。なお、マニュアル８４１には、所定のフォーマットに従って、文字列、区切り文字、空白、改行等が追加されてもよい。図３では、マニュアル８４１の、コマンドの名称の直前に文字列“Name:”が、コマンドの説明の直前に文字列“Desctiption:”が、末尾に空行が追加されている。

以上説明したように、本実施形態のマニュアル生成装置１００は、ＣＬＩを介して操作される情報処理装置２００からコマンド情報を取得し、取得したコマンド情報に基づいてマニュアルを自動的に生成する。つまり、本実施形態のマニュアル生成装置１００では、生成されるマニュアルの部分や、コマンドの仕様を示すデータを予め用意する必要がない。従って、本実施形態のマニュアル生成装置１００では、ＣＬＩを介して操作される情報処理装置のマニュアルの作成を効率化することができるという効果がある。

なお、ＣＬＩにおいて複数の「入力モード」が存在する場合には、マニュアル生成装置１００は、各入力モードへ順次移行して、各入力モードにおけるコマンド情報を取得することにより、マニュアルを生成してもよい。「入力モード」とは、入力可能なコマンドが限定されたＣＬＩにおける各状態である。入力モードは、メニュー上の、階層、カテゴリー等に対応して設定される。例えば、最上位の入力モードでは、各入力モードへの移行、及び各入力モードの概要説明に関するコマンド情報の取得が可能である。また、例えば、下位の入力モードでは、各入力モードのコマンドの実行、現在の入力モードの詳細説明に関するコマンド情報の取得、及び最上位の入力モードへの移行が可能である。

また、マニュアル生成装置１００は、指定されたコマンド又は入力モードについて、マニュアルを生成してもよい。

また、マニュアル作成者は、マニュアル生成装置１００により生成されたマニュアルを元に、マニュアルの作成を行ってもよい。
（第２の実施形態）
次に、上述した第１の実施形態のマニュアル生成装置を基本とする、本発明の第２の実施形態のマニュアル生成装置について説明する。本実施形態のマニュアル生成装置は、通信回線を介して情報処理装置に接続される。また、本実施形態のマニュアル生成装置では、第１の実施形態のマニュアル情報取得手段が３つの手段に分割されている。以下の説明において、第１の実施形態と同等の構成要素には同じ符号を付し、適宜説明を省略する。

本実施形態における構成について説明する。

図４は、本発明の第２の実施形態のマニュアル生成装置１０５の構成の一例を示すブロック図である。

まず、マニュアル生成装置１０５を含むマニュアル生成システム５０５の構成について説明する。マニュアル生成システム５０５は、情報処理装置２０５とマニュアル生成装置１０５とを含む。情報処理装置２０５とマニュアル生成装置１０５とは、通信回線２４０を介して接続される。通信回線２４０では、例えば、シリアルポートの通信規格に従ってデータ交換が行われる。

情報処理装置２０５は、通信回線２４０においてＣＬＩにより操作される情報処理装置である。情報処理装置２０５は、例えば、通信機器、入出力機器、記憶装置、コンピュータである。情報処理装置２０５は、ＣＬＩ手段２１０を含む。ＣＬＩ手段２１０は、ＣＬＩのコマンドを入力して、コマンドに対応する操作を行い、コマンドに対するＣＬＩのレスポンスを出力する。特に、ＣＬＩ手段２１０は、コマンド情報取得コマンドを入力して、コマンド情報を出力する。

マニュアル生成装置１０５は、通信回線２４０においてＣＬＩを介して情報処理装置２０５のコマンド情報を取得し、コマンド情報に基づいてマニュアルを生成する。マニュアル生成装置１０５は、コマンド情報の取得やマニュアルの生成以外の機能を含んでもよい。例えば、マニュアル生成装置１０５は、情報処理装置２０５のシリアルコンソールとしての機能を含んでもよい。なお、本実施形態のマニュアル生成装置１０５は情報処理装置２０５をＣＬＩを介して操作できればよく、マニュアル生成装置１０５と情報処理装置２０５との間の接続方式はシリアル接続には限定されない。マニュアル生成装置１０５は、コマンド入出力手段１１５と、コマンド情報取得手段１２５と、コマンド情報解析手段１３５と、マニュアル生成手段１４５とを含む。

コマンド入出力手段１１５は、情報処理装置２０５のＣＬＩ手段２１０を介して情報処理装置２０５の操作を行う。コマンド入出力手段１１５は、通信回線２４０において、ＣＬＩを介して、情報処理装置２０５へコマンドを出力し、情報処理装置２０５からコマンドに対するレスポンスを入力する。特に、コマンド入出力手段１１５は、情報処理装置２０５へコマンド情報取得コマンドを出力し、情報処理装置２０５からコマンド情報を入力する。

コマンド情報取得手段１２５は、コマンド入出力手段１１５に対してコマンド情報の取得を指示し、コマンド入出力手段１１５からコマンド情報を取得する。

コマンド情報解析手段１３５は、コマンド情報取得手段１２５により取得されたコマンド情報を解析する。

マニュアル生成手段１４５は、コマンド情報解析手段１３５により解析されたコマンド情報に基づいてマニュアルを生成する。

次に、本実施形態における動作について説明する。

図５は、本発明の第２の実施形態のマニュアル生成装置１０５の動作を示すフローチャートである。なお、図５に示されるフローチャート及び以下の説明は一例であり、適宜求める処理に応じて、処理順等を入れ替えたり、処理を戻したり、又は処理を繰り返したりしてもよい。

コマンド情報取得手段１２５は、情報処理装置２０５から通信回線２４０上のＣＬＩを介してコマンドリスト情報を取得する（ステップＳ２２０）。

コマンド情報解析手段１３５は、コマンド情報取得手段１２５により取得されたコマンドリスト情報を解析する（ステップＳ２３０）。

コマンド情報取得手段１２５は、コマンドリスト情報に含まれる特定のコマンドについて、情報処理装置２０５から通信回線２４０上のＣＬＩを介してコマンド個別情報を取得する（ステップＳ２４０）。

コマンド情報解析手段１３５は、コマンド情報取得手段１２５により取得されたコマンド個別情報を解析する（ステップＳ２５０）。

コマンド情報解析手段１３５は、コマンド情報解析手段１３５によるコマンド情報の解析結果に基づいて、コマンド個別情報を未取得のコマンドの有無を判定する（ステップＳ２６０）。コマンド個別情報を未取得のコマンドがある場合には（ステップＳ２６０：Ｎｏ）、コマンド情報解析手段１３５は、コマンド個別情報を未取得の特定のコマンドについて、ステップＳ２４０の処理へ戻る。コマンド個別情報を未取得のコマンドがない場合には（ステップＳ２６０：Ｙｅｓ）、コマンド情報解析手段１３５は、ステップＳ２７０の処理へ進む。

マニュアル生成手段１４５は、コマンド情報解析手段１３５によるコマンド情報の解析結果に基づいてマニュアルを生成する（ステップＳ２７０）。

次に、本実施形態における処理の具体例について説明する。なお、本実施形態ではコマンド情報取得コマンドを示す文字列は限定されないが、本具体例では、コマンド情報取得コマンドを示す文字列として“？”を例に説明する。情報処理装置２０５のＣＬＩ手段２１０は、コマンドリスト情報取得コマンド“？”に対して、コマンドの名称及び概要説明を含むコマンドリスト情報を返す。情報処理装置２０５のＣＬＩ手段２１０は、コマンド個別情報取得コマンド“CMD ？”（“CMD”はコマンドの名称）に対して、コマンドのパラメータの名称及び概要説明を含むコマンド個別情報を返す。

図６は、本発明の第２の実施形態のマニュアル生成装置１０５の処理の具体例を説明するための図である。具体的には、図６は、マニュアルのタイトル部分の生成例を示す。

マニュアル生成装置１０５は、コマンドリスト情報取得コマンド９１１を使用して、情報処理装置２０５からコマンドリスト情報９２１を取得する（ステップＳ２２０）。コマンドリスト情報取得コマンド９１１は、文字列“？”のみを含む。取得したコマンドリスト情報９２１には、コマンドの名称の一覧と、各コマンドの説明とが含まれる。

マニュアル生成装置１０５は、コマンドリスト情報９２１を解析して、コマンドの名称とコマンドの説明とを抽出する（ステップＳ２３０）。具体的には、マニュアル生成装置１０５は、コマンドの名称として“CMD1”、“CMD2”、“CMD3”を、コマンドの説明として“explanation1”、“explanation2”、“explanation3”を抽出する。なお、余分な、文字列、区切り文字、空白、改行等は、抽出結果から除外される。

マニュアル生成装置１０５は、コマンドの説明をタイトルとして含み、タイトルの次の行にコマンドの名称を含む、マニュアルの部分９３１を生成する（ステップＳ２７０）。具体的には、マニュアル生成装置１０５は、１行目にコマンド“CMD1”の説明“explanation1”を、2行目にコマンド“CMD1”の名称を含む、マニュアルの部分９３１を生成する。同様に、マニュアル生成装置１０５は、4行目にコマンド“CMD2”の説明“explanation2”を、5行目にコマンド“CMD2”の名称を含む、マニュアルの部分９３１を生成する。同様に、マニュアル生成装置１０５は、7行目にコマンド“CMD3”の説明“explanation3”を、8行目にコマンド“CMD3”の名称を含む、マニュアルの部分９３１を生成する。なお、マニュアルの部分９３１には、所定のフォーマットに従って、文字列、区切り文字、空白、改行等が追加されてもよい。図６では、マニュアルの部分９３１の、先頭に区切り文字（四角の記号）が、末尾に空行が追加されている。

図７は、本発明の第２の実施形態のマニュアル生成装置１０５の処理の具体例を説明するための図である。具体的には、図７は、マニュアルのコマンド毎の説明部分の生成例を示す。

マニュアル生成装置１０５は、コマンドリスト情報９２１に含まれる特定のコマンド“CMD1”について、コマンド個別情報取得コマンド９１２を使用して、情報処理装置２０５からコマンド個別情報９２２を取得する（ステップＳ２４０）。コマンド情報取得コマンド９１２は、個々のコマンド名に続く文字列“？”を含む。取得したコマンド個別情報９２２には、コマンド毎の、パラメータの名称と、パラメータの説明とが含まれる。

マニュアル生成装置１０５は、コマンド個別情報９２２を解析して、パラメータの名称とパラメータの説明とを抽出する（ステップＳ２５０）。具体的には、マニュアル生成装置１０５は、パラメータの名称として“PARAM-A”、“PARAM-B”を、パラメータの説明として“explanationA”、“explanationB”を抽出する。なお、余分な、文字列、区切り文字、空白、改行等は、抽出結果から除外される。

マニュアル生成装置１０５は、マニュアルの部分９３１において、コマンドの名称の次の行にパラメータの名称を記載し、各パラメータの説明を各パラメータの名称の右側に記載した、マニュアルの部分９３２を生成する。具体的には、マニュアル生成装置１０５は、マニュアルの部分９３１において、3行目にパラメータ“PARAM-A”の名称、及びパラメータ“PARAM-A”の説明“explanationA”を、4行目にパラメータ“PARAM-B”の名称、及びパラメータ“PARAM-B”の説明“explanationB”が挿入されたマニュアルの部分９３２を生成する。同様に、マニュアル生成装置１０５は、コマンド個別情報を未取得の特定のコマンド“CMD2”、“CMD3”について、パラメータの名称及びパラメータの説明が挿入されたマニュアルの部分を生成することにより、マニュアル全体を生成する（ステップＳ２７０）。なお、マニュアルの部分９３２には、所定のフォーマットに従って、文字列、区切り文字、空白、改行等が追加されてもよい。図７では、マニュアルの部分９３２の、先頭に区切り文字（四角の記号）が、末尾に空行が追加されている。

以上説明したように、本実施形態のマニュアル生成装置１０５は、ＣＬＩを介して操作される情報処理装置２０５からコマンド情報を取得し、取得したコマンド情報に基づいてマニュアルを生成する。従って、本実施形態のマニュアル生成装置１０５では、ＣＬＩを介して操作される情報処理装置のマニュアルの作成を効率化することができるという効果がある。

なお、ＣＬＩにおいて複数の入力モードが存在する場合には、マニュアル生成装置１０５は、各入力モードへ順次移行して、各入力モードにおけるコマンド情報を取得することにより、マニュアルを生成してもよい。

また、マニュアル生成装置１０５は、指定されたコマンド又は入力モードについて、マニュアルを生成してもよい。

また、マニュアル作成者は、マニュアル生成装置１０５により生成されたマニュアルを元に、マニュアルの作成を行ってもよい。
（第３の実施形態）
次に、上述した第２の実施形態のマニュアル生成装置を基本とする、本発明の第３の実施形態のマニュアル生成装置について説明する。本実施形態のマニュアル生成装置は、指定された特定のコマンドのみについて、マニュアルの生成を行う。以下の説明において、第２の実施形態と同等の構成要素には同じ符号を付し、適宜説明を省略する。

本実施形態における構成について説明する。

図８は、本発明の第３の実施形態のマニュアル生成装置１０６の構成の一例を示すブロック図である。

マニュアル生成装置１０６は、第２の実施形態のマニュアル生成装置１０５の各手段に加えて、コマンド名取得手段１５６を含む。

コマンド名取得手段１５６は、利用者により入力された、マニュアルに記載される対象であるコマンド示す文字列を取得する。

本実施形態におけるその他の構成は、第２の実施形態における構成と同じである。ただし、本実施形態のマニュアル生成装置１０６のマニュアル生成手段１４６は、第２の実施形態のマニュアル生成装置１０５のマニュアル生成手段１４５と動作が異なる。すなわち、マニュアル生成手段１４６は、コマンド名取得手段１５６により取得されたコマンドに関するマニュアルの部分を抽出して出力する。

次に、本実施形態における動作について説明する。

図９は、本発明の第３の実施形態のマニュアル生成装置１０６の動作を示すフローチャートである。なお、図９に示されるフローチャート及び以下の説明は一例であり、適宜求める処理に応じて、処理順等を入れ替えたり、処理を戻したり、又は処理を繰り返したりしてもよい。

コマンド名取得手段１５６は、利用者により入力された、マニュアルに記載される対象であるコマンドを示す文字列を取得する（ステップＳ２１０）。

本実施形態におけるステップＳ２２０からステップＳ２７０までの動作については、第２の実施形態における動作と同一であるため、説明を省略する。

マニュアル生成手段１４６は、コマンド名取得手段１５６により取得された文字列が、コマンドの名称として含まれるマニュアルの部分を抽出し、抽出した部分をマニュアルとして出力する（ステップＳ２８０）。

次に、本実施形態における処理の具体例について説明する。

図１０は、本発明の第３の実施形態のマニュアル生成装置１０６の処理の具体例を説明するための図である。具体的には、図１０は、“dhcp”コマンドに関するマニュアルの部分を抽出する処理の例を示す。

マニュアル９４１は、全てのコマンドを含む、抽出前のマニュアルである。つまり、マニュアル９４１は、第２の実施形態で述べたステップＳ２７０の処理が終了した直後のマニュアルである。マニュアル９４１は、コマンド“route”、“ip”、“dhcp”、及び“snmp”に関する部分を含む。また、各コマンドに関するマニュアルの部分は、区切り文字（四角の記号）により開始され、空行により終了される。

マニュアル９４２は、“dhcp”コマンドに関する部分のみを含む、抽出後のマニュアルである。つまり、マニュアル９４２は、ステップＳ２８０の処理が終了した直後のマニュアルである。

まず、コマンド名取得手段１５６は、利用者により入力された、マニュアルに記載される対象であるコマンドを示す文字列“dhcp”を取得する（ステップＳ２１０）。

次に、マニュアル生成装置１０６は、ステップＳ２２０からステップＳ２７０の処理を実行した結果、マニュアル９４１を生成する。ステップＳ２２０からステップＳ２７０の処理は、第２の実施形態における処理と同様であるので、詳細な説明を省略する。

次に、マニュアル生成手段１４６は、コマンド名取得手段１５６により取得された文字列“dhcp”が、コマンドの名称として含まれるマニュアルの部分を抽出してマニュアル９４２を生成する（ステップＳ２８０）。具体的には、マニュアル生成手段１４６は、マニュアル９４１における“dhcp”コマンドに関する部分を、指定された“dhcp”コマンドに関するマニュアル９４２として抽出する。“dhcp”コマンドに関するマニュアル９４２には、“dhcp”コマンドにおいて指定可能なパラメータ“server”とパラメータ“client”の名称及び説明も含まれる。なお、１つのコマンドに関するマニュアルの部分は、区切り文字（四角の記号）により開始され、空行により終了される部分として識別される。

以上説明したように、本実施形態のマニュアル生成装置１０６は、特定のコマンドの名称を取得し、特定のコマンドに関するマニュアルの部分を抽出して、特定のコマンドに関する部分のみを含むマニュアルを生成する。従って、本実施形態のマニュアル生成装置１０６には、本発明の第２の実施形態のマニュアル生成装置の効果に加えて、利用者により必要とされるコマンドのみに関するマニュアルを生成することができるという効果がある。

なお、本実施形態のマニュアル生成装置１０６は、コマンド名取得手段１５６により取得されたコマンドについてのみ、コマンド情報を取得し、解析する処理を行ってもよい。すなわち、本実施形態のマニュアル生成装置１０６は、ステップＳ２８０の処理を行う代わりに、ステップＳ２１０で取得されたコマンドについてのみ、ステップＳ２３０からステップＳ２６０までの処理を行ってもよい。この場合には、本実施形態のマニュアル生成装置１０６には、上述の効果に加えて、マニュアルを生成するために必要な計算量及び時間を低減することができるという効果がある。

また、上述した本発明の各実施形態のマニュアル生成装置は、専用の装置によって実現してもよいが、コンピュータ（情報処理装置）によっても実現可能である。この場合、係るコンピュータは、メモリ（不図示）に格納されたソフトウェア・プログラムをＣＰＵ（Central_Processing_Unit、不図示）に読み出し、読み出したソフトウェア・プログラムをＣＰＵにおいて実行することにより、実行結果を、例えば、ユーザ・インタフェースに出力する。上述した各実施形態の場合、係るソフトウェア・プログラムには、上述したところの、図１に示したマニュアル生成装置１００の各手段、図４に示したマニュアル生成装置１０５の各手段、図８に示したマニュアル生成装置１０６の各手段の機能を実現可能な記述がなされていればよい。ただし、マニュアル生成装置１００、マニュアル生成装置１０５、及びマニュアル生成装置１０６の各手段には、適宜ハードウェアを含むことも想定される。そして、このような場合、係るソフトウェア・プログラム（コンピュータ・プログラム）は、本発明を構成すると捉えることができる。更に、係るソフトウェア・プログラムを格納した、コンピュータ読み取り可能な記憶媒体も、本発明を構成すると捉えることができる。

以上、本発明を、上述した各実施形態およびその変形例によって例示的に説明した。しかしながら、本発明の技術的範囲は、上述した各実施形態およびその変形例に記載した範囲には限定されない。当業者には、係る実施形態に対して多様な変更又は改良を加えることが可能であることは明らかである。そのような場合、係る変更又は改良を加えた新たな実施形態も、本発明の技術的範囲に含まれ得る。そしてこのことは、特許請求の範囲に記載した事項から明らかである。

本発明は、ＣＬＩを介して操作される、情報処理装置又はプログラムの、マニュアルを作成する用途において、利用できる。

１００、１０５、１０６ マニュアル生成装置
１１５ コマンド入出力手段
１２０、１２５ コマンド情報取得手段
１３５ コマンド情報解析手段
１４０、１４５、１４６ マニュアル生成手段
１５６ コマンド名取得手段
２００、２０５ 情報処理装置
２１０ ＣＬＩ手段
２４０ 通信回線
５００、５０５ マニュアル生成システム
８１１ コマンドリスト情報取得コマンド
８１２、８１３ コマンド個別情報取得コマンド
８２１ コマンドリスト情報
８２２、８２３ コマンド個別情報
８４１ マニュアル
９１１ コマンドリスト情報取得コマンド
９１２ コマンド個別情報取得コマンド
９２１ コマンドリスト情報
９２２ コマンド個別情報
９３１、９３２ マニュアルの部分
９４１、９４２ マニュアル

Claims (9)

1. コマンドラインインタフェースを介して操作される情報処理装置の、前記コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、前記コマンドラインインタフェースを介して前記情報処理装置から取得するコマンド情報取得手段と、
   前記コマンド情報に基づいて、前記コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成手段と、
   を備えたことを特徴とするマニュアル生成装置。
2. 前記コマンド情報は、前記コマンドのパラメータの名称又は説明を含む
   ことを特徴とする請求項１に記載のマニュアル生成装置。
3. 前記コマンド情報取得手段は、前記コマンドラインインタフェースのコマンドヘルプ機能を利用してコマンド情報を取得する
   ことを特徴とする請求項１又は請求項２に記載のマニュアル生成装置。
4. 前記マニュアル生成手段は、特定の前記コマンドの利用方法が説明されたマニュアルを生成する
   ことを特徴とする請求項１乃至３のいずれか１項に記載のマニュアル生成装置。
5. 前記コマンド情報取得手段は、特定の前記コマンドについての前記コマンド情報を取得する
   ことを特徴とする請求項１乃至４のいずれか１項に記載のマニュアル生成装置。
6. 前記マニュアル生成手段は、前記コマンドの名称又は説明に第１の文字列を付加し、前記コマンドの前記パラメータの名称又は説明に第２の文字列を付加したマニュアルを生成する
   ことを特徴とする請求項２に記載のマニュアル生成装置。
7. コマンドラインインタフェースを介して操作される情報処理装置とマニュアル生成装置とを備え、
   前記マニュアル生成装置は、前記情報処理装置の、前記コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、前記コマンドラインインタフェースを介して前記情報処理装置から取得するコマンド情報取得手段、並びに、
   前記コマンド情報に基づいて、前記コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成手段、
   を備えたことを特徴とするマニュアル生成システム。
8. コマンドラインインタフェースを介して操作される情報処理装置の、前記コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、前記コマンドラインインタフェースを介して前記情報処理装置から取得し、
   前記コマンド情報に基づいて、前記コマンドの利用方法が説明されたマニュアルを生成する
   ことを特徴とするマニュアル生成方法。
9. コマンドラインインタフェースを介して操作される情報処理装置の、前記コマンドラインインタフェースにおけるコマンドの、名称又は説明を含むコマンド情報を、前記コマンドラインインタフェースを介して前記情報処理装置から取得するコマンド情報取得処理と、
   前記コマンド情報に基づいて、前記コマンドの利用方法が説明されたマニュアルを生成するマニュアル生成処理と、
   をコンピュータに実行させることを特徴とするマニュアル生成プログラム。

Images