JPH06124193A - ドキュメント管理方式 - Google Patents

Abstract

(57)【要約】 【目的】 ソースコード中の各対象物に対して、それに
対応するドキュメントをハイパー的に結合して、各対象
物に対応するドキュメントを簡便に参照できるようにす
ること。 【構成】 ファイル管理部１３は、管理情報ファイル格
納部３，ソースコードファイル格納部４，及びドキュメ
ントファイル格納部５との間でファイルの入出力を行
う。管理情報保持部１２は、ソースコード中の各対象物
（関数定義，変数定義等）とドキュメントとの対応関係
を示す管理情報を保持する。管理情報保持部１２に保持
された管理情報は、ソースコードが修正された時、それ
に応じて更新される。ドキュメントを参照するには、管
理情報保持部１２の管理情報に従って、ツールウィンド
ウ内に、上記各対象物の前にクリック用のマークを表示
させ、マウスでそれをクリックすることにより、その対
象物に対応したドキュメントをウィンドウ式に表示させ
る。

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明は、ソフトウェアの開発支
援におけるドキュメント管理方式に関するものである。

【０００２】

【従来の技術】ソフトウェアの開発・保守作業者にソフ
トウェアの正確な情報を提供するために、自然言語で記
載した文書あるいは図式等よりなるドキュメントを作成
している。それらのドキュメントは、通常紙に印刷して
保存したり、あるいは、コンピュータの記憶装置にデー
タとして保存したりしている。そして、ソフトウェアの
開発・保守作業者が必要になった時には、その保存場所
から目的とするドキュメントを探し出して、利用できる
ようにしている。

【０００３】

【発明が解決しようとする課題】しかしながら、前記し
た従来の技術には、ソフトウェアであるソースコードと
それに対応するドキュメントとが、完全に独立して存在
しており、ソースコードとドキュメントとの対応付けが
充分にとれないという問題点があった。

【０００４】そのため、複数人でソフトウェアの開発を
している時、ドキュメントがどこにあるのかは、それぞ
れの人が覚えておかなければならず、他の人が作成した
ドキュメントを参照する場合は、いちいちその人にドキ
ュメントの保存場所を聞かなければならない。その解決
策として、コンピュータでソースコードとそれに対応す
るドキュメントとを集中的に管理するという方法も考え
られるが、大規模なシステムが必要になる上、たとえそ
のようにしたとしても、ソースコードのバージョンアッ
プが行われた時に、それに応じたドキュメントの改訂が
行われたか否か確認できず、ドキュメントの品質に不安
が残る。また、ドキュメントは、ソースコードが有して
いる情報を完全に表すことは不可能であり、ソースコー
ドと完全に独立したドキュメントでは、ソースコード自
体（コード自身及びコメント文）が有する情報を有効に
活用できない。本発明は、以上のような問題点を解決す
ることを課題とするものである。

【０００５】

【課題を解決するための手段】前記課題を解決するた
め、本発明のドキュメント管理方式では、ソースコード
ファイルを格納するソースコードファイル格納部と、ド
キュメントを格納するドキュメントファイル格納部と、
ソースコードファイル中の各対象物（ソースコード中の
メソッド（関数，プロシージャ）定義，定数定義，変数
定義及びソースコード全体）とドキュメントとの関係を
示す管理情報ファイルを格納する管理情報ファイル格納
部と、管理ツールとを有し、該管理ツールは、上記各フ
ァイル格納部からファイルを読み込み、読み込まれたソ
ースコードが修正された際には、それに応じて管理情報
ファイルを更新し、読み込まれたソースコードに対応す
るドキュメントを表示させる際には、上記管理情報ファ
イルの管理情報に基づいて、各対象物に付された指示用
マークをソースコードと共にツールウィンドウ内に表示
させ、該指示用マークを指示することによりそれが付さ
れている対象物に対応するドキュメントをウィンドウ表
示させることとした。

【０００６】

【作 用】管理ツールにより、ソースコードファイル
が修正された際には、それに応じて管理情報ファイルを
更新する。また、ドキュメントを表示させる際には、上
記のようにして更新された最新の管理情報に基づいて、
ソースコードと共に各対象物に付された指示用マークが
ツールウィンドウ内に表示され、該指示用マークをマウ
スクリック等により指示すれば、それにリンクされたド
キュメントがウィンドウ表示される。そのようにして、
ソースコード中の各対象物に対して、それに対応するド
キュメントがハイパー的に結合される。そのため、ドキ
ュメントの保存場所をいちいち覚えておかなくても、各
対象物に対応するドキュメントを随時参照することがで
きる。また、ソースコードも同時に表示されるので、コ
ード自身及びコメント文が有している情報を有効に活用
できる。さらに、上記管理情報は、ソースコードが修正
される度毎に更新されるので、ソースコードとドキュメ
ントとの現在の対応関係を確実に把握でき、ドキュメン
トの品質に対する不安は解消される。

【０００７】

【実施例】以下、本発明の実施例を図面に基づいて詳細
に説明する。図１は、本発明の概要を示すブロック図で
ある。図１において、１は管理ツール、２は管理情報フ
ァイル格納部、３はソースコードファイル格納部、４は
ドキュメントファイル格納部、５はソースコードエディ
タ、６はドキュメントエディタ、１１は制御部、１２は
管理情報保持部、１３はファイル管理部、１４はソース
コード処理部、１５は管理情報処理部である。

【０００８】管理ツール１は、本発明のドキュメント管
理方式を実行するためのツールであり、管理情報保持部
１２を有している。管理情報保持部１２では、対象物情
報，ドキュメント指示子情報，前バージョンのコード情
報及びトラッシュデータ情報等の管理情報を保持してい
る。

【０００９】ファイル管理部１３は、管理情報ファイル
格納部２，ソースコードファイル格納部３，ドキュメン
トファイル格納部４と管理ツール１との間のファイルの
入出力を行う。ソースコード処理部１４は、ソースコー
ドファイル格納部３からソースコードファイルを読み込
んできた時、あるいは、ソースコードの修正作業が終了
した時等にソースコードをスキャンして、対象物情報を
把握したり、把握した対象物情報と管理情報保持部１２
中の対象物情報との照合を行ったりする。管理情報処理
部１５は、ソースコード処理部１４で対象物情報の照合
した結果に基づいて、管理情報保持部１２中の管理情報
を修正する。

【００１０】ソースコードファイル格納部３及びドキュ
メントファイル格納部４は、必ずしも一箇所に集中して
設けられたものではなく、多数に分散して格納されてい
る場合もあるが、それぞれ複数のソースコードファイル
及びドキュメントを格納している。各ソースコードファ
イル及びドキュメントは、管理ツール１を通して、或い
は管理ツール１とは別個に、ソースコードエディタ５あ
るいはドキュメントエディタ６によって適宜編集するこ
とができる。なお、ソースコードエディタ５及びドキュ
メントエディタ６は、既存のものを用いることができ、
特に制約されない。また、ソースコードも既存のもので
よく、ドキュメントとしてもどのようなものでも取り扱
うことができる。

【００１１】図２は、管理情報保持部の内容の一例を示
す図である。対象物情報とは、ドキュメント対象物であ
るメソッド（関数，プロシージャ）定義，定数定義，変
数定義等に関する情報であり、対象物の名前、該対象物
のテキストファイル内の位置情報（例、行番号）、及
び、該対象物に対応するドキュメントの管理状態を示す
データ等から成る。

【００１２】ドキュメント指示子情報は、ドキュメント
オブジェクトをポイントするものであり、代表的にはフ
ァイル名である。また、ここには、ドキュメント情報と
して、ドキュメントをセーブした時の日付情報，ドキュ
メントのサイズ，フォーマット等が保持される。このド
キュメント情報は、ドキュメント指示子情報の中に埋め
込んでもよいし、独立して管理し、それへのポインタを
ドキュメント指示子情報に持たせてもよい。図２は、後
者の場合を示している。前バージョンのコード情報（ソ
ースコード内容物）は、ソースコードファイル格納部３
から読み込まれたソースコードファイルを保持したもの
で、その後ソースコードが修正された時に、修正後のソ
ースコードとの比較のために用いられる。

【００１３】図３は、本発明における表示画面の一例を
示す図である。図３において、３２，３４，３６は、対
象物であり、３０，３１，３３，３５は、各対象物とド
キュメントとの対応関係示すボックスである。これらの
ボックスは、各対象物の前に表示され、ドキュメントの
管理状態に応じて形状を異ならせている。例えば、ボッ
クス３０，３５は、この対象物に対応したドキュメント
が確かに存在していることを示している。また、ボック
ス３１は、この対象物に対応するドキュメントが存在し
ていないことを示している。そしてまた、ボックス３３
は、この対象物に対応したドキュメントはあるが、対象
物とドキュメントとの一貫性は崩れている可能性がある
ことを示している。なお、ボックス３０は、特定の対象
物に対応するドキュメントではなくて、当該ソースコー
ドファイル全体に関するドキュメントとを結合してい
る。

【００１４】図３の表示画面において、いずれかのボッ
クスをマウスでクリックすると、利用可能なドキュメン
トの種類がメニュー形式でウィンドウ表示される。図４
は、ドキュメントの種類を選択するためのメニュー画面
の一例を示す図である。図４において、４１〜４３はボ
ックスである。ボックス４１をクリックすると通常の文
書が表示され、ボックス４２をクリックするとフローチ
ャートが表示され、ボックス４３をクリックするとＤＦ
Ｄ（データ・フロー・ダイアグラム）が表示される。

【００１５】例えば、ボックス４３をクリックすると、
図５のような、ウィンドウ画面が表れる。これは、ＤＦ
Ｄの一例であり、各バブルＰ₁ 〜Ｐ₃ はプロセス、各矢
印はデータフローを表している。なお、図４では、文
書，フローチャート，ＤＦＤ・・・のようにドキュメン
トの表示方式のみでメニューを表示しているが、一つの
対象物に対して複数個のＤＦＤなりフローチャート等が
ある場合もある。そのような場合は、各表示方式毎に、
それら複数の同一表示方式ドキュメントを、互いに区別
できるような名前を付けて表示する細展開メニューを用
意しておき、その表示方式が選択された時は、上記細展
開メニュー画面をウィンドウ表示させることにより一つ
のドキュメントを選択可能にすることができる。

【００１６】また、図４の画面から、その対象物に対し
て新たなドキュメントを追加したり、削除したり、ある
いは変更したりするための操作を行うこともできる。そ
の操作には、次のようなシートが使われる。図６は、ド
キュメントの追加，削除，変更を指示するための表示画
面の一例を示す図である。

【００１７】この画面は、図４の画面において、どこか
指定された箇所をクリックすることによって表示させ
る。この画面において、欄Ｎに、追加，削除，変更の対
象となるドキュメントの名前を入力し、欄Ｆに該ドキュ
メントが格納されているファイル名を入力する。その入
力方法としては、キーボード等を使って入力することも
できるが、ボックス６１，６２をクリックすることによ
りメニューを表示させ、そのなかから一つを選択して入
力するようにもできる。例えば、図４のものに新たにＳ
Ｃ（Structure Chart,構造図）を追加する場合は、図６
の欄Ｎに「ＳＣ」を入力し、欄Ｆにそれが格納されてい
るファイル名を入力して処理を実行する。また、図４の
ものから、「ＤＦＤ」を削除する場合は、欄Ｎに「ＤＦ
Ｄ」を入力し、欄Ｆを空欄にして処理を実行する。

【００１８】次に、本発明の動作を説明する。本発明の
基本的な動作として、ロード動作，アップデート動作，
セーブ動作がある。それらの動作を、フローチャートを
参照しながら以下に説明する。

【００１９】（ロード動作）ロード動作は、管理情報フ
ァイル格納部２及びソースコードファイル格納部３か
ら、管理ツール１にファイルを読み込むための動作であ
る。図７は、ロード動作の手順を示すフローチャートで
ある。 ステップ１…ソースコードファイル格納部３から、該当
するソースコードファイルを検索して、管理ツール１の
ソースコード処理部１４に読み込む。 ステップ２…ソースコード処理部１４では、ソースコー
ドからドキュメント対象物をリストアップし、それらの
名前，ファイル内位置情報等を調べて、それらのデータ
を対比用対象物情報として保持する。

【００２０】ステップ３…管理情報ファイル格納部２か
ら、当該ソースコードに対応する管理情報ファイルを検
索して読み込む。 ステップ４…読み込んだ管理情報ファイルを、管理情報
保持部１２に格納する。 ステップ５…ソースコード処理部１４内に保持している
上記対比用対象物情報及びソースコードと、管理情報保
持部１２に格納した管理情報とを照合して、管理情報中
の該対象物の管理状態を示すデータをセットする。ま
た、ドキュメントファイル格納部４を調べて、その結果
に応じて管理状態を示すデータを修正する。 ステップ６…修正された管理情報に従って、図３に示す
ような画面をツールウィンドウ内に表示する。その後、
ソースコードの編集作業等が行われる。

【００２１】（アップデート動作）アップデート動作
は、ソースコードを編集している際に、現在のソースコ
ードの内容に応じて、管理情報を書き換えるための動作
である。図８，図９は、アップデート動作の手順を示す
フローチャートである。フローチャートは、図８と図９
に二分割して示している。 ステップ１…ソースコードからドキュメント対象物をリ
ストアップし、それらの名前，ファイル内位置情報を調
べて、それらのデータを対比用対象物情報として保持す
る。

【００２２】ステップ２…最初の対象物を取り出す。 ステップ３…ステップ１でリストアップされた全ての対
象物について、既に管理対象になっているか否かの判別
処理（ステップ４の処理）が行われたか否かを判別す
る。 ステップ４…全ては判別処理されておらず、判別処理す
べき対象物が残っている時、当該対象物が既に管理対象
になっているか否かを判別する。すなわち、管理情報保
持部１２中の対象物情報の中にその名前が入っているか
否かを判別する。 ステップ５…管理対象になっている時、現ソースコード
と管理情報中の前バージョンコード情報とを照合し、両
者のコード情報が同じか否かを判別する。 ステップ６…同じである時、管理情報保持部１２のファ
イル内位置情報を上記対比用対象物情報のものに更新す
る。 ステップ７…同じではない時、管理情報保持部１２の管
理状態を示すデータを「一貫性が崩れているかもしれな
い」ということを示すデータに修正する。

【００２３】ステップ８…ステップ４で管理対象にはな
っていない時、管理情報保持部１２の対象物情報中に、
実効的に同じ（表現上で多少の差異はあっても、内容的
には等しいと見做される）コード情報のものがあるか否
かを判別する。 ステップ９…あれば、単に名前が変更されたものとし
て、管理情報中の対象物の名前を、当該対象物のものに
変更する。 ステップ１０…次の対象物を取り出してステップ３以降
の処理を繰り返す。

【００２４】ステップ１１…ステップ３でリストアップ
された全ての対象物について、既に管理対象になってい
るか否かの判別処理が行わたと判別された時、ステップ
８で実効的に同じコード情報のものがなかった対象物
（全く新しいものか、あるいはコード情報も名前も変更
された既存のもの。以下、未処理対象物という）の内、
最初の対象物を取り出す。 ステップ１２…全ての未処理対象物について、旧ドキュ
メント情報を引き継ぐか否かの判別処理（ステップ１３
の処理）が行われたか否かを判別する。

【００２５】ステップ１３…まだ、判別処理が行われて
いない対象物が残っている時、管理情報保持部１２中に
新しい対象物情報を作成する。 ステップ１４…旧ドキュメント情報を引き継ぐか否かを
判別する。 ステップ１５…引き継ぐ場合、引き継ぐべきドキュメン
ト情報を当該対象物に移動し、それまでそのドキュメン
ト情報を保持していた移動元の対象物情報を削除する。 ステップ１６…次の未処理対象物を取り出す。 ステップ１７…ステップ１２で全ての未処理対象物につ
いて判別処理が行われたと判別された時、管理情報保持
部１２中に未処理の対象物が残っていたら、トラッシュ
にする（トラッシュデータとして保存するか、あるいは
廃棄する）。

【００２６】なお、上記ステップ１３〜ステップ１５の
処理は、次のようなツールウィンドウを使って行う。図
１０は、アップデート動作中、旧ドキュメント情報を引
き継ぐか、新しい対象物情報を作成するための処理を行
うためのツールウィンドウの一例を示す図である。図１
０において、１０１〜１０３は対象物表示欄、１０４，
１０５はクリック用ボックスである。

【００２７】このツールウィンドウは、上記ステップ１
２で判別処理すべき対象物が残っている時に表示され
る。表示欄１０１には、現在処理しようとしている未処
理対象物の名前が表示され、表示欄１０２には、新しい
対象物情報を作成する旨の表示が行われ、表示欄１０３
以降には、管理情報保持部１２にある未処理の対象物に
ついて、対象物の名前と、それに対応するドキュメント
名がリストアップされる。そして、リストアップされた
対象物に付けられた、いずれかのボックスをクリックす
ることにより、現在処理しようとしている未処理対象物
に、そのドキュメント情報が移動する。その場合、管理
状態は、「一貫性が崩れているかも知れない」となる。

【００２８】また、過去の古いドキュメント情報を使わ
ない場合は、ボックス１０２をクリックする。そうする
と、管理情報保持部１２中に新しい対象物情報を作成す
る。その場合、管理状態は、「対応するドキュメントな
し」となる。

【００２９】（セーブ動作）セーブ動作は、アップデー
トの済んだ管理情報を管理情報ファイル格納部２に格納
するための動作である。図１１は、セーブ動作の手順を
示すフローチャートである。 ステップ１…上記アップデート動作を行う。 ステップ２…アップデートの済んだ管理情報を管理情報
ファイル格納部２に格納する。

【００３０】

【発明の効果】以上述べた如く、本発明のドキュメント
管理方式によれば、ソースコード中の各対象物に対し
て、それに対応するドキュメントがハイパー的に結合さ
れるので、ドキュメントの保存場所をいちいち覚えてお
かなくても、各対象物に対応するドキュメントを随時参
照することができる。また、ソースコードも同時に表示
されるので、コード自身及びコメント文等が有している
情報を有効に活用できる。さらに、上記管理情報は、ソ
ースコードが修正される度毎に更新されるので、ソース
コードとドキュメントとの現在の対応関係を確実に把握
でき、ドキュメントの品質に対する不安は解消される。
また、ソースコードエディタ及びドキュメントエディタ
は、既存のものを用いることができ、特に制約されな
い。

【図面の簡単な説明】

【図１】 本発明の概要を示すブロック図

【図２】 管理情報保持部の内容の一例を示す図

【図３】 本発明における表示画面の一例を示す図

【図４】 ドキュメントの種類を選択するためのメニュ
ー画面の一例を示す図

【図５】 ドキュメントの表示例を示す図

【図６】 ドキュメントの追加，削除，変更を指示する
ための表示画面の一例を示す図

【図７】 ロード動作の手順を示すフローチャート

【図８】 アップデート動作の手順の一部を示すフロー
チャート

【図９】 アップデート動作の手順の残りの一部を示す
フローチャート

【図１０】 アップデート動作中、旧ドキュメント情報
を引き継ぐか、新しい対象物情報を作成するための処理
を行うためのツールウィンドウの一例を示す図

【図１１】 セーブ動作の手順を示すフローチャート

【符号の説明】

１…管理ツール、２…管理情報ファイル、３…ソースコ
ードファイル、４…ドキュメント、５…ソースコードエ
ディタ、６…ドキュメントエディタ、１１…制御部、１
２…管理情報保持部、１３…ファイル管理部、１４…ソ
ースコード処理部、１５…管理情報処理部

Claims (1)

【特許請求の範囲】
1. 【請求項１】 ソースコードファイルを格納するソース
   コードファイル格納部と、ドキュメントを格納するドキ
   ュメントファイル格納部と、ソースコードファイル中の
   各対象物とドキュメントとの関係を示す管理情報ファイ
   ルを格納する管理情報ファイル格納部と、管理ツールと
   を有し、該管理ツールは、上記各ファイル格納部からフ
   ァイルを読み込み、読み込まれたソースコードが修正さ
   れた際には、それに応じて管理情報ファイルを更新し、
   読み込まれたソースコードに対応するドキュメントを表
   示させる際には、上記管理情報ファイルの管理情報に基
   づいて、各対象物に付された指示用マークをソースコー
   ドと共にツールウィンドウ内に表示させ、該指示用マー
   クを指示することによりそれが付されている対象物に対
   応するドキュメントをウィンドウ表示させるようにした
   ことを特徴とするドキュメント管理方式。