JPH0390934A - 文書に対する妥当性のチェック方式 - Google Patents

Abstract

(57)【要約】本公報は電子出願前の出願データであるた
め要約のデータは記録されません。

Description

【発明の詳細な説明】 〔産業上の利用分野〕 本発明は１文書編集装置における文書に対する妥当性の
チェック方式に関し、特に一定の記述項目に基づいて構
成したプログラム仕様書と、これに対応するソースコー
ドとの妥当性をチェックし、プログラム仕様書を自動修
正することが可能な文書に対する妥当性のチェック方式
に関する。

〔従来の技術〕

コンピュータ・システムの普及に伴って、ソフトウェア
開発も大規模化し、新規開発が頻繁に行われるようにな
ってきている。また、既存の母体プログラムに対して改
造を加える母体依存型の開発形態も増加している。

通常、ソフｉ−ウェアを新規開発する際には、プログラ
ム仕様書を作成するが、バージョンアップ等の改造を加
えるものについては、プログラム仕様書の改訂がなされ
ず、ソースコードとの間に、内容的な相異が生じる場合
がある。この場合、ソースコードに頼るプログラム開発
となり、ソースコードの分析、調査に膨大な作業時間を
費やすことになる。

このことから、ソースコードを自動的に解析して、プロ
グラム仕ｔｌ書を自動的に作成する方法が提案されてい
る。

例えば、特開昭６３−３０１３２８号公報に記載されて
いる方法では、詳細仕様書を作成する場合、モジュール
間の情報を整理して、ソースプログラムと一致した詳細
仕様書を効率よく作成するため、作業を３部分に分けて
行っている。

〔発明が解決しようとする課題〕

上記従来技術では、ソースコードを解析し、このソース
コードに対応する詳細仕様書を新規に生成しているが、
既存のプログラム仕様書と現在のソースコードとの対応
付けによる妥当性のチェックについては配慮がなされて
いなかった。

すなわち５人間の思考に基づいて記述されたプログラム
仕様書と、これに基づいて生成されたソースコードとの
矛盾を検出するためには、−度、ソースコードの解析を
行った上で文書を作成して、手作業により、既存のプロ
グラム仕様書との対応づけを行って矛盾を検出するか、
あるいは、既存のプログラム仕様書を全く不用とするの
で、既存のプログラム仕様書に基づいたソースコードと
の妥当性の検出は・なされていなかった。また、手作業
による対応づけであるため、作業効率および妥当性の検
出の信頼性に問題があった。

本発明の目的は、このような問題点を改善し、ある決め
られた記述項目から構成されたプログラム仕様書に対応
するソースコードを解析し、解析結果をプログラム仕様
書の記述項目に従って編集し、各項目の構成要素を対応
づけることによって、ソースコードとプログラム仕様書
の内容の妥当性を自動的に検出し、また、その検出結果
を自動的にプログラム仕様書に反映することにより、既
存のプログラム仕様書とソースコードの内容を一致させ
て、プログラム仕様書の信頼性および保守性を向上する
ことが可能な文書に対する妥当性のチェック方式を提供
することにある。

〔課題を解決するための手段〕

上記目的を達成するため、本発明の文書に対する妥当性
のチェック方式は、ソース・プログラムと、ソース・プ
ログラムに対応し、所定の記述項目から構成された文書
とを格納する手段を備えた文書編集装置において、その
格納手段に格納されている文書に対応するソースコード
を解析し、解析結果に基づいて、所定の記述項目の構成
要素ごとにその文書の妥当性をチェックし、記述項目の
不足および不統一をその文書に反映させて、自動的に修
正することに特徴がある。

〔作用〕

本発明においては、プログラム仕様書（以下文書と呼ぶ
）を記述する上で定められた記述項目規則を、予め記述
項目規則記憶部により記憶する。

そして、ソースコード用の外部記憶装置からソースコー
ドを入力して解析し、さらに、予め記憶された記述項目
規則に従い、その解析結果を編集する。

次に、入力表示装置より入力され、定められた記述項目
に従って構成されて、既に文書用の外部記憶装置に格納
されている文書のうち、解析したソースコードに対応す
る文’Ｉｌ’ｘ入力する。そして、同し項目を土個の単
位として、ソースコードの解析編集結果と文書の当該要
素を比較し、妥当性をチェックして相異点を検出し、そ
の結果を入力表示装置あるいはプリンタ装置に出力して
、文書の編集者に訂正を促す。

さらに、必要に応じて、検出したソースコードと文書の
相異点を文書上に自動的に反映し、修正結果を文書用の
外部記憶装置に格納する。

また、文書用の外部記憶装置に、解析したソースコード
に対応する文書がない場合、妥当性チェック結果として
、この旨を報告する。なお、必要に応じ、ソースコード
の解析編集結果を新規文書として、文書用の外部記憶装
置に格納することもできる。

このように、ソースコードと文書の間の内容の一致を機
械的にチェックすることができ、かつ。

修正も自動的に行うことができるので、文書の信頼性お
よび保守性を向上させる。

〔実施例〕

以下１本発明の一実施例を図面により説明する。

第２図は、本発明の一実施例におけるプログラム自動作
成システムの構成図である。

入力した文書の表示、および文書の妥当性チェック結果
を表示する入力／表示装置、２は文書の編集、ソースコ
ードの解析および解析結果の編集、文書の妥当性チェッ
クを制御する制御装置、３は外部記憶装置からソースコ
ードを入力して解析するソースコード解析部、４はソー
スコードの解析結果を定められた文書の記述項目に基づ
いて編集するソースコード解析結果編集部５５は外部記
憶装置から入力した文書とソースコード解析結果編集部
４で編集された結果の妥当性をチェックする文書チェッ
ク部、６は文書チェック部５で検出したチェック結果を
自動的に文書に反映する文書自動変更部、７は記述項目
に基づいて文書を作成する文書作成部、８は文書を記述
する上で定められた記述項目を予め記憶する記述項目規
則記憶部、９は内部メモリ、１０はソースコードを格納
するソースコード用の外部記憶装置、１１は編集した文
書を保存する文書用の外部記憶装置、１２は編集した文
書および文書の妥当性チェック結果を印字／出力するプ
リンタ装置である。

次に、本実施例における対象ソースコードの解析２Ｍ解
析結果編集、既存文書の妥当性チェック、およびチェッ
ク結果の反映に至る一連の処理手順について述べる。

第１図は、本発明の一実施例における文書に対する妥当
性のチェック方式の処理手順を示すフローチャートであ
る。

本実施例では１編集者は、外部記憶装置１０より、解析
対象のソースコードを内部メモリ９に入力する（１０１
）。

次に、これをソースコード解析部３において解析しく１
０２）、予め記述項目規則記憶部８により記憶されてい
る記述項目規則に従って、解析結果を編集する（１０３
）。

次に、解析したソースコードに対応する文書が外部記憶
装置１１上にあれば、これを内部メモリ９に入力しく１
０４，１０５）、ソースコードの解析編集結果と既存文
書を、記述項目規則記憶部８により記憶されている記述
項目規則を参照しながら、各記述項目を単位として、そ
の構成要素について比較し、相異点を検出する（１０６
）。

その結果、構成要素に相異がある場合には（１０７）、
入力／表示装置１あるいはプリンタ装置１２にメツセー
ジを出力する（１０８）。

さらに、既存文書に対して、検出した相異点を反映する
必要があれば（１０９）、文書を自動修正しく１１０）
、修正した文書を外部記憶装置１↓に格納する（１１１
．）。

また、ステップ１０５において、解析したソースコード
に対応する文書が外部記憶装置１１に存在しない場合に
は、文書が存在しない旨を示すメツセージを入力／表示
装置１あるいはプリンタ装置１２に出力する（１１２）
。

さらに、ソースコードに対応する文書を作成する必要が
あれば（１１３）、ソースコードの解析編集結果を新規
文書として外部記憶装置１１に格納する（１１１）。

次に、既存文書とソースコードの解析編集結果の妥当性
チェック、およびチェック結果に基づく既存文書の自動
修正の処理手順（ステップ１０６〜１１０）について、
詳細に述べる。

第３図は、本発明の一実施例におけるソースコードと文
書の妥当性チェック、およびチェック結果に基づく文書
の自動修正の処理手順を示すフローチャー１−である。

本実施例では、ソースコードの解析編集結果と、外部記
憶装置１１から入力した文書を内部メモリ９に入力し、
記述項目規則記憶部８に記憶されている記述項目規則を
参照して、各記述項目を１個の単位として、この構成要
素を比較する（３０１）。

その結果、構成要素の中、ソースコードの解析編集結果
上には存在し１文書上には存在しないものがある場合（
３０２）、該当する構成要素が文書において記述不足で
ある旨を示すメツセージを入力／表示装置１あるいはプ
リンタ装置１２に出力する（３０３）。

さらに１文書を自動修正する必要がある場合には（３０
４）、該当する構成要素を文書の当該記述項目の構成要
素に追加する（３０５）。

また、構成要素の中、ソースコードの解析編集結果上は
存在せず、文書上には存在する場合には（３０２，３０
６）、該当する構成要素が文書において記述過多である
旨を示すメツセージを入力／表示装置１あるいはプリン
タ装置１２に出力する（３０７）。この場合、該当する
構成要素が人間の思考に基づいて記述されている可能性
もあるので、情報を不当に削除することを防止するため
に文書の自動修正は行わない。

また、ソースコードの解析編集結果と文書の構成要素が
全く異なる場合には（３０６，３０８）、ソースコード
と文書の一致性がない旨を示すメツセージを入力／表示
装置１あるいはプリンタ装置１２に出力する（３０９）
。

さらに、文書を自動修正する必要がある場合には（３１
０）、文書の当該記述項目の構成要素を削除し、ソース
コードの解析結果の構成要素を文書の当該記述項目の構
成要素に置き換える（３１１）。

〔発明の効果〕

本発明によれば、一定の記述項目規則に基づいて構成さ
れた既存の文書に対応するソースコードを自動的に解析
し、かつ、その文書と同じ記述項目規則に解析結果を整
理して、その解析結果に基づき、相互の妥当性を自動的
にチェックして、内容の相異を検出することにより、チ
ェック結果を表示することができる。

このため、手作業によるソースコードの解析や文書との
内容の妥当性チェックにかかる作業量を軽減させ、解析
およびチェック作業の精度を向上することができる。

また、チェック結果に基づき、文書を自動的に修正して
、外部記憶装置上に格納することができるため、ソース
コードと文書を一対として、文書の信頼性および保守性
を向上させる。

さらに、解析したソースコードに対応する既存文書がな
い場合には、ソースコードの解析編集結果を新規文書と
して外部記憶装置上に格納することにより、効率よくソ
ースコードに対応した文書を作成することができる。

【図面の簡単な説明】

第１図は本発明の一実施例における文書に対する妥当性
のチェック方式の処理手順を示すフローチャート、第２
図は本発明の一実施例におけるプログラム自動作成シス
テムの構成図、第３図は本発明の一実施例におけるソー
スコードと文書の妥当性チェック、およびチェック結果
に基づく文書の自動修正の処理手順を示すフローチャー
トである。 １：入力／表示装置、２：制御装置、３：ソースコード
解析部、４：ソースコード解析結果編集部。 ５：文書チェック部、６：文書自動変更部、７；文書作
成部、８：記述項目規則記憶部、９：内部メモリ、１０
：ソースコード用の外部記憶装置。 １１：文書用の外部記憶装置、１２：プリンタ装置。

Claims (1)

【特許請求の範囲】
1. １、ソース・プログラムと、該ソース・プログラムに対
   応し、所定の記述項目から構成された文書とを格納する
   手段を備えた文書編集装置において、該格納手段に格納
   されている文書に対応するソースコードを解析し、解析
   結果に基づいて、所定の記述項目の構成要素ごとに該文
   書の妥当性をチェックし、記述項目の不足および不統一
   を該文書に反映させて、該文書を自動的に修正すること
   を特徴とする文書に対する妥当性のチェック方式。