JP5150657B2 - Manual correction location presentation device, system, method and program - Google Patents
Manual correction location presentation device, system, method and program Download PDFInfo
- Publication number
- JP5150657B2 JP5150657B2 JP2010020357A JP2010020357A JP5150657B2 JP 5150657 B2 JP5150657 B2 JP 5150657B2 JP 2010020357 A JP2010020357 A JP 2010020357A JP 2010020357 A JP2010020357 A JP 2010020357A JP 5150657 B2 JP5150657 B2 JP 5150657B2
- Authority
- JP
- Japan
- Prior art keywords
- software
- manual
- identification information
- side identification
- source code
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Expired - Fee Related
Links
- 238000000034 method Methods 0.000 title claims description 95
- 238000012937 correction Methods 0.000 title claims description 76
- 230000008569 process Effects 0.000 claims description 86
- 230000008859 change Effects 0.000 claims description 54
- 238000012545 processing Methods 0.000 claims description 54
- 230000004048 modification Effects 0.000 claims description 28
- 238000012986 modification Methods 0.000 claims description 27
- 230000010365 information processing Effects 0.000 claims description 20
- 238000012217 deletion Methods 0.000 claims description 12
- 230000037430 deletion Effects 0.000 claims description 12
- 230000014509 gene expression Effects 0.000 claims description 5
- 230000006870 function Effects 0.000 description 159
- 230000015654 memory Effects 0.000 description 14
- 238000007792 addition Methods 0.000 description 9
- 230000006872 improvement Effects 0.000 description 9
- 238000010586 diagram Methods 0.000 description 7
- 238000005516 engineering process Methods 0.000 description 5
- 238000013519 translation Methods 0.000 description 4
- 238000000926 separation method Methods 0.000 description 3
- 230000003936 working memory Effects 0.000 description 2
- TVEXGJYMHHTVKP-UHFFFAOYSA-N 6-oxabicyclo[3.2.1]oct-3-en-7-one Chemical compound C1C2C(=O)OC1C=CC2 TVEXGJYMHHTVKP-UHFFFAOYSA-N 0.000 description 1
- 238000004590 computer program Methods 0.000 description 1
- 238000012790 confirmation Methods 0.000 description 1
- 230000007547 defect Effects 0.000 description 1
- 238000000605 extraction Methods 0.000 description 1
- 238000007689 inspection Methods 0.000 description 1
- 238000007562 laser obscuration time method Methods 0.000 description 1
- 230000002250 progressing effect Effects 0.000 description 1
- 230000004044 response Effects 0.000 description 1
- 238000000638 solvent extraction Methods 0.000 description 1
Images
Landscapes
- Stored Programmes (AREA)
Description
本発明は、ソフトウェアの変更に伴ってそのソフトウェアに係わる製品等のマニュアルの修正や管理を行う際に好適なマニュアル修正箇所提示装置、マニュアル修正箇所提示システム、マニュアル修正箇所提示方法およびマニュアル修正箇所提示プログラムに関する。 The present invention provides a manual correction location presentation apparatus, a manual correction location presentation system, a manual correction location presentation method, and a manual correction location presentation suitable for correcting and managing a manual of a product related to the software in accordance with a change in software. Regarding the program.
多くの製品は、最初の発売後も、より付加価値の高い製品に変更したり、現在存在する不具合を解消するために改良が加えられるのが通常である。製品の改良には、ハードウェアの改良とソフトウェアの改良が存在する。各種の改良が迅速に要求される昨今では、特にソフトウェアの改良が頻繁に行われており、それらの改版間隔が短くなっている。ソフトウェアの改版と共にマニュアルの改版が行われることが多い。 Many products are usually changed to higher value-added products after the initial release, and improvements are usually made to eliminate existing defects. Product improvements include hardware improvements and software improvements. In recent years, when various improvements are required promptly, software is improved frequently, and the interval between revisions is shortened. Manual revisions are often performed along with software revisions.
ところで、マニュアルの改版の際に改訂箇所を簡易に把握できることが好ましい。そこで本発明の関連技術では、新リビジョンのマニュアル(以下、新マニュアルという。)と直近の旧リビジョンのマニュアル(以下、旧マニュアルという。)を比較して、異なる箇所を検出するようにしている。その結果、両マニュアルの間で異なる箇所が検出された場合には、その箇所を含む新マニュアルのセクションの属性部分に更新された旨を記録するようにしている。本発明の関連技術では、これらの相違箇所における新旧の翻訳文を表示して翻訳表示のバラツキをなくすようにしている。 By the way, it is preferable that the revised part can be easily grasped when the manual is revised. Therefore, in the related technology of the present invention, a new revision manual (hereinafter referred to as a new manual) is compared with a latest old revision manual (hereinafter referred to as an old manual) to detect different portions. As a result, when a different location is detected between the two manuals, the fact that the update has been made is recorded in the attribute portion of the section of the new manual that includes the location. In the related art of the present invention, old and new translated sentences at these different points are displayed to eliminate variations in translation display.
以上説明した本発明の関連技術では、新旧のマニュアルの相違している箇所を検出してその部分の翻訳箇所を表示して対比させることで、新たに行った翻訳表示を従来の翻訳表示に統一させるということが可能になる。この関連技術は、新旧のマニュアル双方の第1国の言語による記載内容が正確に行われていることを前提として、第2国の言語に翻訳した際の翻訳者の違いや翻訳時期の違いによる翻訳表現の相違を解消しようとするものである。 In the related technology of the present invention described above, the newly translated display is unified with the conventional translated display by detecting the difference between the old and new manuals and displaying and comparing the translated part of the part. It becomes possible to let. This related technology is based on differences in translators and translation times when translated into a second country language, assuming that both the old and new manuals are accurately described in the first country language. It is intended to eliminate differences in translation expressions.
ところでソフトウェアの改版が短時間に行われるような場合には、マニュアルの改版も短時間に行う必要がある。ソフトウェアの改版作業とマニュアルの改版作業は必ずしも同期して行われるものではない。予定していたソフトウェアの改良作業の一部が難航するような場合には、難航している改良作業を他の改良作業と分離して次回以降の改版に先延ばしする場合がある。これとは反対に新たな機能が今回の改版のために急遽実現する場合もある。このようなことから、製品のマニュアルにはソフトウェアの変更前の仕様に関する記載が残ってしまったり、新たに追加されたソフトウェアによる機能に関する説明が抜けてしまうおそれがある。 By the way, when software revision is performed in a short time, it is necessary to also perform a manual revision in a short time. Software revision work and manual revision work are not necessarily performed synchronously. When a part of the planned software improvement work is difficult, there is a case where the difficult improvement work is separated from other improvement work and postponed to the next and subsequent revisions. On the other hand, new functions may be realized suddenly due to this revision. For this reason, there is a possibility that the description of the specifications before the software change remains in the product manual or the explanation of the function by the newly added software is lost.
本発明の関連技術では、新旧のソフトウェアの相違箇所が示される。この関連技術では、原文と翻訳文の単純な対応関係を有しているので、マニュアルの新旧の対応関係と、翻訳文の新旧の対応関係は明瞭である。ところが、前記したように新旧のソフトウェアと新旧のマニュアルは、必ずしも明確に対応しない。したがって、本発明の関連技術を使用するだけではソフトウェアとマニュアルの細かな対応関係を採ることができず、ソフトウェアの改定に伴ってマニュアルの記載漏れやソフトウェアの内容と無関係な記載が追加されるおそれがあった。 In the related art of the present invention, differences between old and new software are shown. Since this related technology has a simple correspondence between the original sentence and the translated sentence, the correspondence between the old and new manuals and the correspondence between the old and new translation sentences are clear. However, as described above, old and new software and old and new manuals do not always correspond clearly. Therefore, a detailed correspondence between software and a manual cannot be achieved only by using the related technology of the present invention, and there is a risk that a description that is not related to the contents of the software or a description that is not related to the contents of the software will be added due to the revision of the software. was there.
そこで本発明の目的は、ソフトウェアの改版に伴うマニュアルの修正に関する情報を提示できるマニュアル修正箇所提示装置、マニュアル修正箇所提示システム、マニュアル修正箇所提示方法およびマニュアル修正箇所提示プログラムを提供することにある。 SUMMARY OF THE INVENTION An object of the present invention is to provide a manual correction location presentation device, a manual correction location presentation system, a manual correction location presentation method, and a manual correction location presentation program that can present information related to manual revision accompanying software revision.
本発明では、(イ)ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較手段と、(ロ)ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込手段と、(ハ)前記したソフトウェア比較手段で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成手段と、(ニ)前記したマニュアル読込手段で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成手段と、(ホ)このマニュアル側対応リスト作成手段で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別手段とをマニュアル修正箇所提示装置が具備する。 In the present invention, (a) first software in which source code is divided into predetermined units, and software-side identification information uniquely indicating each of the divided areas is embedded in each of the divided locations; Software comparison means for inputting second software, which is a revision of the first software embedded with side identification information, and comparing the respective areas for each software side identification information, and (b) describing the description contents of the software And the manual side identification information uniquely indicating each of the divided areas is embedded in each of the divided locations, and the software side identification information of the software described above is described in each area. The software side identification information indicates whether it corresponds to the source code of The manual reading means for reading the first manual corresponding to the first software described above embedded in the corresponding manual-side identification information portion and (c) the above-mentioned software comparing means for comparing each area As a result, “Modify” is applied to the area where the source code has been changed due to the revision, “Delete” is applied to the area where the corresponding source code has been deleted, and “Add” is added when the source code with new contents is added. And a software classification list creating means for creating a classification list divided according to each software side identification information, and (d) the manual side of the first manual read by the manual reading means. Corresponding software side identification information for the second software described above for each identification information Manual side correspondence list creating means for creating a list, and (e) whether all the source codes corresponding to each manual side identification information in the list created by the manual side correspondence list creation means have been deleted, or at least one The first manual accompanying the revision from the first software to the second software described above indicates whether the part has been modified or a source code having a new content that does not exist in the first software has been added. The manual correction location presenting device comprises a manual change location discrimination means for discriminating about.
また、本発明では、(イ)ソフトウェアのソースコードおよびそのソフトウェアのマニュアルのデータを入力する入力装置と、(ロ)前記したソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較手段と、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込手段と、前記したソフトウェア比較手段で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成手段と、前記したマニュアル読込手段で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成手段と、このマニュアル側対応リスト作成手段で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別手段とを備えた情報処理装置と、(ハ)この情報処理装置の処理結果としてのマニュアル修正箇所に関するデータを出力する出力装置とをマニュアル修正箇所提示システムが具備する。 In the present invention, (b) an input device for inputting software source code and manual data of the software, and (b) dividing the source code described above into predetermined units, The first software in which unique software-side identification information is embedded in each delimited place and the second software that is a revised version of the first software in which the software-side identification information is embedded are input to the above-described software. Software comparison means that compares each area for each side identification information, and a sentence that describes the contents of the software description is divided into predetermined units, and manual side identification information that uniquely indicates each of these divided areas It is embedded in the delimited place, and the description of each area is described above. The software corresponding to the first software in which the corresponding software-side identification information is embedded in the corresponding manual-side identification information corresponding to the software-side identification information source code of the software. As a result of comparing each area with the manual reading means that reads the manual of the software and the software comparison means described above, the area where the source code has been changed due to the revision is changed to "modified", and the area where the corresponding source code has been deleted. Is a software classification list creating means for creating a classification list in which “deletion” is performed, and “addition” is classified according to each of the above-mentioned software side identification information when a source code having new contents is added, The manual of the first manual read by the manual reading means described above. Manual-side correspondence list creating means for creating a list in which the software-side identification information is associated with the second software for each of the above-mentioned second software, and the manual described above in the list created by the manual-side correspondence list creating means Whether the source code corresponding to each side identification information has been deleted, at least part of it has been modified, or source code having a new content that does not exist in the first software is added. An information processing apparatus comprising manual change location determination means for determining the first manual in accordance with the revision of the software to the second software, and (c) manual correction as a processing result of the information processing apparatus The output device that outputs data related to the location The office presentation system is provided.
更に本発明では、(イ)CPU(Central Processing Unit)が所定のアプリケーションソフトウェアを実行することにより機能的に実現するソフトウェア比較手段によって、ソースコードを所定の単位で区切り、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ前記したCPUを備えたマニュアル修正箇所提示装置に入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較ステップと、(ロ)前記したCPUにより機能的に実現するマニュアル読込手段によって、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを前記したマニュアル修正箇所提示装置に読み込むマニュアル読込ステップと、(ハ)前記したソフトウェア比較ステップで領域ごとに比較した結果、前記したCPUにより機能的に実現するソフトウェア用区分けリスト作成手段によって改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成ステップと、(ニ)前記したマニュアル読込ステップで読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記したCPUにより機能的に実現するマニュアル側対応リスト作成手段によって前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成ステップと、(ホ)このマニュアル側対応リスト作成ステップで作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記したCPUにより機能的に実現するマニュアル変更箇所判別手段によって前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別ステップとをマニュアル修正箇所提示方法が具備する。 Further, in the present invention, (i) by functionally implemented software comparing means by a CPU (Central Processing Unit) executing a predetermined application software, delimit the source code in a predetermined unit, these separated respectively The CPU described above includes first software in which software-side identification information uniquely indicating an area is embedded in each of the divided locations, and second software obtained by revising the first software in which the software-side identification information is embedded. A software comparison step for comparing each area for each piece of software side identification information input to the manual correction location presentation device provided , and (b) manual reading means functionally realized by the CPU described above. Sentences that describe the content are given units The manual side identification information that uniquely identifies each of the divided areas is embedded in each divided place, and the description of each area corresponds to the source code of which software side identification information of the software described above Read the first manual corresponding to the first software in which the corresponding one of the software side identification information is embedded in the corresponding manual side identification information portion into the manual correction location presentation device. (C) As a result of comparison for each area in the above-mentioned software comparison step, the area where the source code has been changed due to the revision by the software classification list creating means functionally realized by the CPU described above is The corresponding source code has been deleted A software classification list creation step for creating a classification list in which “deletion” is added to the area, and “addition” is added according to each software side identification information described above when source code having a new content is added And (d) the second software described above by the manual side correspondence list creating means functionally realized by the CPU for each manual side identification information of the first manual read in the manual reading step. A manual-side correspondence list creation step for creating a list in which the software-side identification information is associated, and (e) a source code corresponding to each manual-side identification information in the list created in the manual-side correspondence list creation step Has been removed or at least The above-mentioned first software by the manual change point discriminating means which functionally realizes whether the part has been modified or whether the source code having a new content which does not exist in the above-mentioned first software has been added. The manual correction location presenting method includes a manual change location discrimination step for discriminating the first manual with the revision to the second software described above.
更にまた本発明では、コンピュータにマニュアル修正箇所提示プログラムとして、(イ)ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較処理と、(ロ)ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込処理と、(ハ)前記したソフトウェア比較処理で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成処理と、(ニ)前記したマニュアル読込処理で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成処理と、(ホ)このマニュアル側対応リスト作成処理で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別処理とを実行させる。 Furthermore, in the present invention, as a manual correction location presentation program in a computer, (a) the source code is divided into predetermined units, and the software side identification information uniquely indicating each of the divided areas is placed in the divided places. Software comparison processing in which the first software embedded and the second software revised from the first software embedded with the software-side identification information are input and the respective areas are compared for each software-side identification information. And (b) dividing the sentence describing the software description in a predetermined unit, and embedding the manual side identification information uniquely indicating each divided area in each divided area. Which software side identification information of the software described above A manual reading process for reading the first manual corresponding to the first software, in which the corresponding one of the software-side identification information is embedded in the corresponding manual-side identification information corresponding to the source code; (C) As a result of comparing each area in the software comparison process described above, “modify” is applied to an area where the source code has been changed due to the revision, and “deleted” is applied to an area where the corresponding source code has been deleted. When the source code having a new content is added, “addition” is a software classification list creation process for creating a classification list that is classified according to each software identification information described above. For each manual side identification information of the first manual read in the manual reading process, Manual side correspondence list creation processing for creating a list in which the above-mentioned software side identification information is associated with each other, and (e) corresponding to each manual side identification information in the list created by this manual side correspondence list creation processing Whether the source code of the part has been deleted, at least part of the source code has been modified, or whether the source code having a new content that does not exist in the first software has been added. In accordance with the revision of the software, manual change location discrimination processing for discriminating the first manual is executed.
以上説明したように本発明によれば、既存のソースコードにタグ等の識別情報を埋め込むだけで、マニュアルの変更に役立つ情報を提示することができるという効果がある。 As described above, according to the present invention, it is possible to present information useful for changing a manual simply by embedding identification information such as a tag in existing source code.
図1は、本発明のマニュアル修正箇所提示装置のクレーム対応図を示したものである。本発明のマニュアル修正箇所提示装置10は、ソフトウェア比較手段11と、マニュアル読込手段12と、ソフトウェア用区分けリスト作成手段13と、マニュアル側対応リスト作成手段14と、マニュアル変更箇所判別手段15を備えている。ここで、ソフトウェア比較手段11は、ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較する。マニュアル読込手段12は、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込む。またこれと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込む。ソフトウェア用区分けリスト作成手段13は、ソフトウェア比較手段11で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成する。マニュアル側対応リスト作成手段14は、マニュアル読込手段12で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成する。マニュアル変更箇所判別手段15は、マニュアル側対応リスト作成手段14で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別する。
FIG. 1 shows a claim correspondence diagram of the manual correction location presenting apparatus of the present invention. The manual correction
図2は、本発明のマニュアル修正箇所提示システムのクレーム対応図を示したものである。本発明のマニュアル修正箇所提示システム20は、入力装置21と、情報処理装置22と、出力装置23を備えている。ここで、入力装置21は、ソフトウェアのソースコードおよびそのソフトウェアのマニュアルのデータを入力する。情報処理装置22は、ソフトウェア比較手段22aと、マニュアル読込手段22bと、ソフトウェア用区分けリスト作成手段22cと、マニュアル側対応リスト作成手段22dと、マニュアル変更箇所判別手段22eを備えている。このうちソフトウェア比較手段22aは、ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較する。マニュアル読込手段22bは、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込む。ソフトウェア用区分けリスト作成手段22cは、ソフトウェア比較手段22aで領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成する。マニュアル側対応リスト作成手段22dは、マニュアル読込手段22bで読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成する。マニュアル変更箇所判別手段22eは、マニュアル側対応リスト作成手段22dで作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別する。出力装置23は、情報処理装置22の処理結果としてのマニュアル修正箇所に関するデータを出力する。
FIG. 2 shows a claim correspondence diagram of the manual correction location presentation system of the present invention. The manual correction
図3は、本発明のマニュアル修正箇所提示方法のクレーム対応図を示したものである。本発明のマニュアル修正箇所提示方法30は、ソフトウェア比較ステップ31と、マニュアル読込ステップ32と、ソフトウェア用区分けリスト作成ステップ33と、マニュアル側対応リスト作成ステップ34と、マニュアル変更箇所判別ステップ35を備えている。ここで、ソフトウェア比較ステップ31では、CPU(Central Processing Unit)が所定のアプリケーションソフトウェアを実行することにより機能的に実現するソフトウェア比較手段によって、ソースコードを所定の単位で区切り、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ前記したCPUを備えたマニュアル修正箇所提示装置に入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較する。マニュアル読込ステップ32では、前記したCPUにより機能的に実現するマニュアル読込手段によって、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込む。また、これと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを前記したマニュアル修正箇所提示装置に読み込む。ソフトウェア用区分けリスト作成ステップ33では、ソフトウェア比較ステップ31で領域ごとに比較した結果、前記したCPUにより機能的に実現するソフトウェア用区分けリスト作成手段によって改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成する。マニュアル側対応リスト作成ステップ34では、マニュアル読込ステップ32で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記したCPUにより機能的に実現するマニュアル側対応リスト作成手段によって前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成する。マニュアル変更箇所判別ステップ35では、マニュアル側対応リスト作成ステップ34で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記したCPUにより機能的に実現するマニュアル変更箇所判別手段によって前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別する。
FIG. 3 shows a claim correspondence diagram of the manual correction location presentation method of the present invention. The manual correction
図4は、本発明のマニュアル修正箇所提示プログラムのクレーム対応図を示したものである。本発明のマニュアル修正箇所提示プログラム40は、コンピュータにソフトウェア比較処理41と、マニュアル読込処理42と、ソフトウェア用区分けリスト作成処理43と、マニュアル側対応リスト作成処理44と、マニュアル変更箇所判別処理45を実行させるようにしている。ここで、ソフトウェア比較処理41では、ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記したソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記したソフトウェア側識別情報ごとにそれぞれの領域を比較する。マニュアル読込処理42では、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込む。またこれと共に、それぞれの領域の記載が前記したソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記した第1のソフトウェアに対応する第1のマニュアルを読み込む。ソフトウェア用区分けリスト作成処理43では、ソフトウェア比較処理で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記したソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成する。マニュアル側対応リスト作成処理44では、マニュアル読込処理で読み込んだ第1のマニュアルの前記したマニュアル側識別情報ごとに前記した第2のソフトウェアについて前記したソフトウェア側識別情報を対応付けたリストを作成する。マニュアル変更箇所判別処理45では、マニュアル側対応リスト作成処理44で作成したリストにおける前記したマニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記した第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記した第1のソフトウェアから前記した第2のソフトウェアへの改版に伴って第1のマニュアルについて判別する。
FIG. 4 is a diagram corresponding to claims in the manual correction location presentation program of the present invention. The manual correction
<発明の第1の実施の形態> <First Embodiment of the Invention>
次に本発明の第1の実施の形態を説明する。 Next, a first embodiment of the present invention will be described.
図5は、本発明の第1の実施の形態によるマニュアル修正箇所提示装置の構成を表わしたものである。このマニュアル修正箇所提示装置100は、ソフトウェアのソースコードやマニュアルの文章の入力を行う入力装置101を備えている。またマニュアル修正箇所提示装置100は、入力装置101から入力されたデータの処理を行うデータ処理部102と、このデータ処理部102に接続された記憶装置103と、データ処理部102の処理結果を出力する出力装置104を備えている。出力装置104は、たとえばディスプレイ装置やプリンタで構成することができる。
FIG. 5 shows the configuration of the manual correction location presentation device according to the first exemplary embodiment of the present invention. The manual correction
データ処理部102は、入力装置101から与えられたマニュアルデータに付されているタグを読み取るタグ読取部111と、新旧のソフトウェアを比較するソフトウェア比較部112と、ソフトウェアの変更箇所を出力装置104に出力する変更箇所提示部113を備えている。ここでソフトウェア比較部112は、入力装置101から与えられた新旧2種類のソフトウェアのコメント記載箇所に埋め込まれているタグを読み込む。そして、モジュールあるいは関数単位でこれら新旧のソフトウェアの比較を行う。ここでモジュールとは、プログラム全体を構成する機能ごとのひとまとまりをいう。関数とは引数と呼ばれるデータを受け取って、定められた処理を実行して結果を返す一連の命令群をいう。本実施の形態で関数とは、ソフトウェアのソースコードを個々に区切る1つの単位である。
The
新旧のソフトウェアの比較結果は、記憶装置103の変更箇所記憶部122にリストとして格納する。変更箇所提示部113は、ソフトウェア比較部112の比較によって新旧のソフトウェアについて差分が生じたと判別するそれぞれの部分に対して、マニュアルに付されたタグとの関連で、記載の修正を行うことが適切だと思われるタグの付いている段落番号の検索を行う。差分が生じたとは、「関数」について内容の改変、削除、追加のいずれかが行われた場合をいう。
The comparison results of the old and new software are stored as a list in the changed
記憶装置103は、関数関係記憶部121と変更箇所記憶部122を備えている。関数関係記憶部121は、タグ読取部111が読み取ったマニュアルにおけるタグの付いている段落を読み取り、新旧両ソフトウェアの関数との関連をリストとして格納する記憶領域である。
The
次に、このような構成のマニュアル修正箇所提示装置100の動作を説明する。
Next, the operation of the manual correction
入力装置101には旧ソフトウェアのソースコードと新ソフトウェアのソースコードおよびマニュアル文章の3点が与えられる。ソフトウェアのソースコードおよびマニュアルには、入力装置101での入力に先立ってタグが付される。ソースコードには複数の関数が含まれており、そこには必ずタグが付く。
The
本実施の形態のマニュアル修正箇所提示装置の前提として、新ソフトウェアは旧ソフトウェアに対して改変を加えたものであるとする。また、新ソフトウェアは旧ソフトウェアの関数自体を削除しない限り、その関数についているタグを削除しないものとする。また、新ソフトウェアで新たに加えた関数(モジュール自体の追加を含む)にはタグを必ず付けるものとし、新たに加えた関数は既存の関数すべてよりも後ろに書かれるものであるとする。 As a premise of the manual correction location presentation device of the present embodiment, it is assumed that the new software is a modification of the old software. The new software does not delete the tag attached to the function unless the function of the old software itself is deleted. Also, it is assumed that a function (including addition of the module itself) newly added with new software is always tagged, and the newly added function is written after all existing functions.
図6は、ソフトウェアのソースコードにタグが挿入された例を示したものである。この例ではソースコード131と次のソースコード132の間にコメント133を配置する。C言語、C++(シープラスプラス)、Java(登録商標)(ジャバ)、Java(登録商標)Script(ジャバスクリプト)、Cascading Style Sheets(カスケーディング・スタイル・シート)では、「/*」と「*/」で括った箇所がコメント133となる。
FIG. 6 shows an example in which a tag is inserted into the software source code. In this example, a
ソースコード131とコメント133の間に空の行は配置しない。この一方で、コメント133と次のソースコード132の間には、1行以上の空の行134を配置する。コメント133の中には、この例では「TagF<A−1>」という文字が記されている。ここで括弧記号の「<」および「>」で括った領域135が関数の番号としての関数番号を示している。図6に示した例では<A−1>が関数番号となる。
An empty line is not placed between the
図7は、マニュアルの文書中にタグおよび関数番号を埋め込んだ様子を表わしたものである。マニュアルの文章151に埋め込むタグはマニュアルを構成する文章とは異なる。このため、マニュアルの文章151を通常の状態で印刷したり表示するとき、タグ自体は不可視のものであり、表示されない。
FIG. 7 shows a state where tags and function numbers are embedded in a manual document. The tags embedded in the
マニュアルの文章151の各段落は、不可視の空行152で区切る。また、各段落における<Name>153に続く括弧記号の「<」および「>」で括った内部154には、段落の番号を記載する。図7に示した例では「1−1」や「2−1」が段落の番号となる。また、<Tag>155に続く「<」および「>」で括ったそれぞれの領域157には、対応するソフトウェアの関数番号が記載される。図7に示した例では<A−1>や<A−3>あるいは<B−1>や<C−2>はそれぞれ関数番号である。
Each paragraph of the
図5に示した入力装置101は、マニュアルの入力を行う際に、図7に示すマニュアルの文章151を章ごとに1字ずつ読み取っていく。そして<Tag>155と記された箇所を順に抽出し、<Name>153というパターンに当てはまった場合は、その1行下に<Tag>155と記されたパターンが存在するかを判別する。<Tag>155と記されたパターンが存在した場合、図5に示したタグ読取部111はこれに続く「<」および「>」で括った領域157を読み取る。これを後に具体的に示す関数関係記憶部121における「関係する関数番号」として追加していく。以上の処理を改行まで繰り返す。
When inputting a manual, the
図8は、リストとしての関数関係記憶部の構成の一例を示したものである。関数関係記憶部121には、「関係する関数番号」という項目が設定されている。図7で示した「関係する関数番号」の内容を、それぞれの「段落」に対応して格納する。それぞれの段落には、「関係する関数番号」として関係する複数の関数番号が記載されることが多い。
FIG. 8 shows an example of the configuration of the function relationship storage unit as a list. In the function
一方、図5に示したソフトウェア比較部112は、入力装置101から与えられた新旧両ソフトウェアのソースコードに埋め込まれたタグを比較する。このとき、空行とタグの下の空行の間を1つの関数とみなす。
On the other hand, the
図9は、旧ソフトウェアのソースコードの一部を示したものである。また、図10は図9に対応した箇所の新ソフトウェアのソースコードを示したものである。図5と共に説明する。 FIG. 9 shows a part of the source code of the old software. FIG. 10 shows the source code of the new software at the location corresponding to FIG. This will be described with reference to FIG.
図9では、1行以上の空の行161と、タグ(Tag)の配置された行162の次に配置された1行以上の空の行163の間の領域164を関数と見なす。図10でも1行以上の空の行171と、タグ(Tag)の配置された行172の次に配置された1行以上の空の行173の間の領域174を関数と見なす。
In FIG. 9, a
ソフトウェア比較部112は、まず、図9におけるタグの配置された行162と、図10におけるタグの配置された行172までをそれぞれ比較しないで読みとばす。次に、タグの配置されたそれぞれの行162、172が同じ関数番号のタグであるかを1字ずつ確認する。この結果、同じ関数番号のタグでないことが判別したら、図9に示した旧ソフトウェアのソースコードを、新ソフトウェアと同じ関数番号のタグが出てくるまで読み進めていく。このようにして、新ソフトウェアに存在しなかった関数番号は、改変箇所リストである変更箇所記憶部122に区分を「削除」として書き込む。
First, the
新旧ソフトウェアのタグの配置された行162、172でタグによって示された関数番号が一致したとする。この場合には、空行161、171およびタグの下の空行163、173の間の関数の領域164、174を改めて1字ずつ逐次比較する。これら新旧の領域164、174を比較した結果、1文字でも両者の間に差分(相違)があったとする。この場合、該当する箇所の関数番号の区分を「改変」として書き込む。比較の結果、新旧の領域164、174で差分が全くなかった場合、その関数番号は変更箇所記憶部122に書き出さない。
Assume that the function numbers indicated by the tags in the
変更箇所提示部113は、修正を行うことが適切であると思われる箇所を提示するためリストとしての変更箇所記憶部122を作成する。
The changed
図11は、この変更箇所記憶部の内容の一例を示したものである。変更箇所記憶部122では、旧ソフトウェアから新ソフトウェアに変更した際に1文字でも差分があった箇所としての関数番号<A−1>を「改変」と区分している。また、旧ソフトウェアから新ソフトウェアに変更した際に削除された箇所としての関数番号<A−4>および<A−7>については、「削除」と区分している。更に、旧ソフトウェアから新ソフトウェアに変更した際に新たに追加された箇所としての関数番号<A−10>については、「追加」と区分している。以下同様である。
FIG. 11 shows an example of the contents of the changed part storage unit. The change
このようにしてソフトウェアの修正された箇所の関数番号とその修正の種類を示す変更箇所記憶部122を作成する。次に、この変更箇所記憶部122に存在するそれぞれの関数番号が関数関係記憶部121(図8)に示した段落の番号に対応して存在するかを確認する。これは、マニュアルとソフトウェアの照合作業である。
In this way, the changed
まず、図11の変更箇所記憶部122に最初に示す関数番号<A−1>が、図8に示す関数関係記憶部121において段落の番号「1−1」に対応する関数番号として存在するかを調べる。次に関数番号<A−1>が段落の番号「1−2」に対応する関数番号として存在するかを調べる。以下、同様に最後の段落の番号「null」まで関数番号<A−1>が存在するかを調べる。
First, whether the function number <A-1> first shown in the changed
関数番号<A−1>については、図8に示したように段落の番号「1−1」に関数番号として存在している。このように対応する関数番号が存在する場合には、その箇所にダブルクォーテーション「“”」を付けて「改変」を表示する。 The function number <A-1> exists as a function number in the paragraph number “1-1” as shown in FIG. When there is a corresponding function number in this way, double quotations ““ ”” are added to the location and “modified” is displayed.
関数番号<A−1>について以上の処理が終了したら、変更箇所記憶部122における次の関数番号<A−4>についても同様の検索処理を行う。ただし、関数番号<A−4>に関しては、区分が「削除」である。そこで、対応する関数番号が関数関係記憶部121に存在した場合には、その関数番号の前にバツ「×」を付けて「削除」を表示する。関数番号<A−7>の処理も関数番号<A−4>の処理と同様である。
When the above processing is completed for the function number <A-1>, the same search processing is performed for the next function number <A-4> in the change
変更箇所記憶部122における次の関数番号<A−10>についても関数関係記憶部121について同様の検索処理を行う。ただし、関数番号<A−10>は新ソフトウェアで新たに追加している。したがって、関数関係記憶部121には該当するタグが存在しない。そこで、この場合には段落を「new」として、関係する関数番号に<A−10>を追加する。
The same search process is performed for the function
以上のようにして、図8に示す関数関係記憶部121の関数番号に注釈が加えられたら、段落の1行ごとに確認を行う。この結果として、次の(1)〜(4)の区分けが行われる。
As described above, when an annotation is added to the function number in the function
(1)同一の段落に対応付けられたすべての関数番号にバツ「×」が付いている場合。
この場合には、その段落を「削除」とする。図8では、段落の番号「1−1」に関係する関数番号が<A−1>と<A−3>になっている。これら関数番号<A−1>と関数番号<A−3>に共にバツ「×」が付いているとすると、段落の番号「1−1」は「削除」となる。
(1) A case in which all the function numbers associated with the same paragraph are marked with a cross “X”.
In this case, the paragraph is “deleted”. In FIG. 8, the function numbers related to the paragraph number “1-1” are <A-1> and <A-3>. If the function number <A-1> and the function number <A-3> are both marked with a cross “x”, the paragraph number “1-1” is “deleted”.
(2)該当する段落の関数番号のすべてにバツ「×」が付いていないものの、一部にバツ「×」が付いていたりダブルクォーテーション「“”」で囲まれている関数番号が存在する場合。
この場合には、その段落を「改変」とする。たとえば関数番号<A−1>と関数番号<A−3>が関係する段落で、関数番号<A−1>のみにバツ「×」が付いている場合、その段落は「改変」となる。
(2) Where all of the function numbers in the corresponding paragraph do not have a cross “x”, but there are function numbers that have a cross “x” in part or are enclosed in double quotations ““ ”” .
In this case, the paragraph is “modified”. For example, if the function number <A-1> and the function number <A-3> are related to each other and only the function number <A-1> is marked with a cross “x”, the paragraph is “modified”.
(3)該当する段落の関数番号のいずれにもバツ「×」が付いておらず、またこれらの関数番号のいずれもがダブルクォーテーション「“”」で囲まれていない場合。
この場合には、その段落を「なし」とする。
(3) A case in which none of the function numbers in the corresponding paragraph is marked with a cross “x” and neither of these function numbers is enclosed in double quotations ““ ””.
In this case, the paragraph is “None”.
(4)「new」となっている段落に関数番号が存在する場合。
この場合には、その段落を「新規」とする。
(4) A function number exists in a paragraph that is “new”.
In this case, the paragraph is “new”.
図12は、区分け時の(1)、(2)または(4)に該当するものを各段落に対応する区分として書き出したものである。(3)として区分けされた段落については、新旧ソフトウェアで何らの変更もない。そこで、図12に示す段落とこれに対応する区分としては書き出さない。段落番号が「null」に該当する箇所についても、書き出さない。 FIG. 12 shows what falls under (1), (2) or (4) at the time of classification as a classification corresponding to each paragraph. Regarding the paragraph classified as (3), there is no change between the old and new software. Therefore, the paragraphs shown in FIG. 12 and the corresponding sections are not written out. The part corresponding to the paragraph number “null” is not written out.
図5に示した出力装置104は、図12で書き出した段落番号をタグとして含む段落を、強調表示のために赤字で表示する。
The
図13は、出力装置の出力内容の一例として図12に対応するものを示している。図12では段落「1−1」に変更が行われている。このため、出力装置の出力内容181としてのマニュアルの段落「1−1」の箇所は、他の箇所の色(黒色)とは異なる赤色で強調表示されている。ただし、図13では赤色に着色された箇所を斜字で表示している。また、改変箇所には改変が行われたことを示す「(改変)」という語句が表示されている。
Figure 13 shows those corresponding to FIG. 12 as an example of the output content of the output device. In FIG. 12 , the change is made to paragraph “1-1”. For this reason, the location of paragraph “1-1” of the manual as the
ユーザは、「(改変)」という文字と共に赤色に強調表示された箇所を見て、ソフトウェアに変更が加えられた箇所に対応するマニュアルの段落であることを知る。したがって、ソフトウェアの改変に対応するマニュアルの修正箇所を簡単にチェックすることができる。 The user sees the part highlighted in red together with the characters “(modified)” and knows that the paragraph is a manual corresponding to the part where the software has been changed. Therefore, it is possible to easily check the correction part of the manual corresponding to the software modification.
また、出力装置の出力内容181におけるマニュアルの最後の部分には、「追加あり」と赤色(斜字)で強調表示されている。これは、図12における「新規」に対応する。ユーザは新ソフトウェアに代わったことによるマニュアルの追加箇所を簡単にチェックすることができる。
The last part of the manual in the
以上説明したように本発明の第1の実施の形態によれば、既存のソースコードにタグを埋め込むだけで、マニュアルにおける変更を行うことが適切な箇所を表示し、確認することができる。また、マニュアル修正箇所提示装置100はハードウェアだけで実現可能である。したがって、CPU(Central Processing Unit)がアプリケーションソフトウェアを実行することで機能する情報処理装置以外の装置でもマニュアル修正箇所提示装置100として実現することができる。
As described above, according to the first embodiment of the present invention, it is possible to display and confirm a place where it is appropriate to make a manual change simply by embedding a tag in the existing source code. Moreover, the manual correction
<発明の第2の実施の形態> <Second Embodiment of the Invention>
次に本発明の第2の実施の形態を説明する。 Next, a second embodiment of the present invention will be described.
図14は、本発明の第2の実施の形態によるマニュアル修正箇所提示システムの構成を表わしたものである。本実施の形態のマニュアル修正箇所提示システム200は、パーソナルコンピュータ等の情報処理装置201と、この情報処理装置201に接続した入力装置101および出力装置103によって構成されている。
FIG. 14 shows a configuration of a manual correction location presentation system according to the second exemplary embodiment of the present invention. A manual correction
情報処理装置201は、CPU211とこのCPU211が実行するプログラムを格納したメモリ212を備えた主制御部213を有している。主制御部213は情報処理装置201を構成するデータ処理部102Aおよび記憶装置103の制御を行う。CPU211は、メモリ212に格納されたプログラムを実行することでデータ処理部102Aを構成するタグ読取部111Aと、ソフトウェア比較部112Aおよび変更箇所提示部113Aを機能的に実現する。ここでタグ読取部111Aは第1の実施の形態のタグ読取部111をソフトウェア的に実現している。また、ソフトウェア比較部112Aは第1の実施の形態のソフトウェア比較部112をソフトウェア的に実現している。更に、変更箇所提示部113Aは第1の実施の形態の変更箇所提示部113Aをソフトウェア的に実現している。ハードウェアとしての記憶装置103は第1の実施の形態と同様であり、関数関係記憶部121と変更箇所記憶部122を備えている。
The
このように第2の実施の形態のマニュアル修正箇所提示システム200は、第1の実施の形態におけるデータ処理部102をソフトウェアとしての機能部で実現すると共に、主制御部213が入力装置101と出力装置104を併せてシステム化している。このため、マニュアル修正箇所提示システム200は、メモリ212に格納されたコンピュータプログラムをCPU211が実行することにより実現する。すなわち、タグ読取部111Aは第1の実施の形態と同様にタグを読み取り、段落との関係を読み取っていく。ソフトウェア比較部112Aは、第1の実施の形態と同様に新旧2つのソフトウェアを比較する。その上で、変更箇所提示部113Aは、変更箇所を提示する。
As described above, in the manual correction
図15は、タグ読取部によるマニュアルの読取処理の様子を表わしたものである。図14と共に説明する。 FIG. 15 shows a state of manual reading processing by the tag reading unit. This will be described with reference to FIG .
タグ読取部111Aは、入力装置101から入力されるマニュアルの情報を1行読み取る(ステップS301)。この読み取った情報がマニュアルの最終行の直後に配置された制御情報であるかを判別することによって、マニュアルの最後まで読み取りを行ったかを判別する(ステップS302)。最終行まで読み取っていない場合には(N)、現在読み取った行はマニュアルの情報である。そこで、この読み取ったマニュアルの行が印刷したり表示する対象とならない不可視部分であるかを判別する(ステップS303)。「段落」や「関係する関数番号」は、不可視部分に記載されており、この部分を抽出する必要があるからである。読み取った行が不可視部分でない場合には(N)、ステップS301に戻ってマニュアルの情報の次の1行の読み取りが行われる。
The
このようにして1行ずつマニュアル情報の読み取りを行っていくと、図7に示したマニュアルの文章151にあるように所定の時点で不可視部分から構成される行の検出が行われる(ステップS303:Y)。この場合には、不可視部分を構成するタグの内容から「段落」および「関係する関数番号」を抽出して関数関係記憶部121に格納する(ステップS304)。「段落」および「関係する関数番号」を抽出するのは1行の処理では行われないが、ここでは簡略に処理を表示している。
When the manual information is read line by line in this way, a line composed of an invisible part is detected at a predetermined time as shown in the
以上のようにしてタグ読取部111Aは、入力装置101から入力されるマニュアルの全情報を読み取って処理することで(ステップS302:Y)、そのマニュアルに含まれる「段落」および「関係する関数番号」のすべてを抽出して、処理を終了する(エンド)。
As described above, the
図16は、新旧ソフトウェアによるタグの比較処理の様子を表わしたものである。図14と共に説明する。 FIG. 16 shows a state of tag comparison processing by new and old software. This will be described with reference to FIG .
まず主制御部213は、入力装置101から新旧両ソフトウェアのソースコードを入力して、メモリ212の図示しない作業用メモリ領域に格納する(ステップS321)。この状態でソフトウェア比較部112Aは旧ソフトウェアのソースコードを先頭から1行等の単位量読み取る(ステップS322)。そして、この読み取ったソースコードに図6で説明したタグが存在するかをチェックする(ステップS323)。
First, the
タグが存在しない場合には(ステップS323:N)、旧ソフトウェアのソースコードを最後まで読み取りその処理を行ったかチェックして(ステップS324)、そうでない場合には(N)、ステップS322の処理に戻る。すなわち、旧ソフトウェアのソースコードを次の単位量読み取って、タグが存在するかを判別する(ステップS323)。 If the tag does not exist (step S323: N), it is checked whether the source code of the old software has been read to the end (step S324), and if not (N), the process of step S322 is performed. Return. That is, the next unit amount is read from the source code of the old software to determine whether a tag exists (step S323).
このようにして旧ソフトウェアのソースコードの最初のタグが見つかったとする(ステップS323:Y)。すると、ソフトウェア比較部112Aは同じタグを持つ関数を新ソフトウェアの先頭から順に探していく(ステップS325)。その関数が新ソフトウェアの最後に到達するまでに見つかれば(ステップS326:Y)、タグの内容を比較する(ステップS327)。その結果が一致すれば(ステップS328:Y)、新ソフトウェアに移行するに際してその関数に何らの変更もなかったことになる。
In this way, it is assumed that the first tag of the source code of the old software is found (step S323: Y). Then, the
そこで、この場合には旧ソフトウェアのソースコードの次のタグを探すことになる。すなわち、旧ソフトウェアのソースコードを最後まで読み取りその処理を行ったかチェックして(ステップS324)、最後まで読み取っていないのであればステップS322に処理を戻す。そして、旧ソフトウェアのソースコードで次のタグを探すことになる。 Therefore, in this case, the next tag in the source code of the old software is searched. That is, it is checked whether or not the source code of the old software has been read and processed (step S324), and if it has not been read, the process returns to step S322. Then, search for the next tag in the source code of the old software.
一方、ステップS326で旧ソフトウェアのソースコードの最初のタグに対する同一のタグが新ソフトウェアの最後まで見つからなかったとする(N)。この場合には、旧ソフトウェアのソースコードのその最初のタグは新ソフトウェアで削除されたことになる。そこで、この新ソフトウェアに存在しなかった関数番号については、改変箇所リストである変更箇所記憶部122に区分を「削除」として書き込む(追加する)(ステップS329)。そして、旧ソフトウェアのソースコードの次のタグを探す作業に取りかかることになる。すなわち、旧ソフトウェアのソースコードを最後まで処理したかをチェックして(ステップS324)、最後まで処理していないのであればステップS322に処理を戻す。このようにして、旧ソフトウェアのソースコードで次のタグを探すことになる。
On the other hand, in step S326, it is assumed that the same tag for the first tag of the source code of the old software is not found until the end of the new software (N). In this case, the first tag of the old software source code is deleted by the new software. Therefore, the function number that did not exist in the new software is written (added) as a “deletion” in the change
もう一つ残った処理として、旧ソフトウェアのソースコードの最初のタグと新ソフトウェアのそれを比較した結果が一致しなかった場合の取り扱いがある。タグの内容が不一致であった場合には(ステップS328:N)、新ソフトウェアのソースコードが変更されたことになる。そこでこの場合には、該当する関数番号について改変箇所リストである変更箇所記憶部122に区分を「改変」として書き込む(追加する)(ステップS330)。そして、旧ソフトウェアのソースコードの次のタグを探す作業に取りかかることになる。すなわち、前記したと同様に旧ソフトウェアのソースコードを最後まで処理したかをチェックして(ステップS324)、最後まで処理していないのであればステップS322に処理を戻す。このようにして、旧ソフトウェアのソースコードで次のタグを探すことになる。
Another remaining process is handling when the first tag of the source code of the old software and the result of comparing the new software do not match. If the contents of the tag do not match (step S328: N), the source code of the new software has been changed. Therefore, in this case, the classification is written (added) as “modified” in the modified
以上のようにして旧ソフトウェアのソースコードの最後まで処理するまでは(ステップS324:N)、旧ソフトウェアのソースコードのタグを順に見つけては、これが新ソフトウェアのタグとしてどうなかったかを調べていく。旧ソフトウェアのソースコードの最後まで読み取りその処理を終了したら(ステップS324:Y)、新ソフトウェアのソースコードに存在する残りの関数を「新規」として改変箇所リストである変更箇所記憶部122に書き込む(追加する)(ステップS331)。そして、一連の処理を終了する(エンド)。
Until the end of the source code of the old software is processed as described above (step S324: N), the tags of the source code of the old software are found in order, and it is checked whether this is the tag of the new software. . When the source code of the old software is read to the end and the process is completed (step S324: Y), the remaining functions existing in the source code of the new software are written as “new” in the changed
図17は、変更箇所提示部によるマニュアルデータの出力処理の前半の処理の様子を表わしたものである。図14と共に説明する。 FIG. 17 shows the state of the first half of the manual data output process by the changed part presentation unit. This will be described with reference to FIG .
変更箇所提示部113Aは、関数関係記憶部121の各段落の番号を順次マニュアルの先頭から読み出すために、マニュアルの段落についての変数Dを初期化する(ステップS351)。段落の番号は図7に示すように<Name>153に続く括弧記号の「<」および「>」で括った内部154で示されるようになっており、この例で初期値としての段落の番号は「1−1」となる。
The change
そこで、変更箇所提示部113Aは、図8に示す関数関係記憶部121の段落の番号「1−1」についての関数番号<A−1>および<A−3>を読み出す(ステップS352)。そして、この例で2つの関数番号<A−1>および<A−3>が、図11に示した変更箇所記憶部122に存在するときの対応する「区分」をこれらの関数番号について表示する(ステップS353)。
Therefore, the changed
具体的には、関数番号<A−1>についてはその箇所にダブルクォーテーション「“”」を付けて「改変」の注釈を埋め込む。もう1つの関数番号<A−3>は変更箇所記憶部122に存在しない。これは関数番号<A−3>で示すソースコードの関数が全く同一の場合であるので、その箇所には「“”」等の「区分」を表わす注釈の埋め込みを行わない。
Specifically, with respect to the function number <A-1>, a double quotation ““ ”” is added at that position and an annotation of “modification” is embedded. The other function number <A-3> does not exist in the changed
ステップS353の処理が行われたら、関数関係記憶部121の最終段落まで処理が進んだ結果として次に処理すべき段落がなくなったかを判別する(ステップS354)。次の段落がまだ存在する場合には(N)、変数Dを次の段落の番号「1−2」に変更する(ステップS355)。そしてステップS352に処理を戻す。その結果、ステップS352では図8に示すように段落の番号「1−2」に関係する関数番号として関数番号<A−4>および<A−7>が関数関係記憶部121から読み出される。
When the process of step S353 is performed, it is determined whether or not there is no paragraph to be processed next as a result of the process progressing to the last paragraph of the function relationship storage unit 121 (step S354). If the next paragraph still exists (N), the variable D is changed to the number “1-2” of the next paragraph (step S355). Then, the process returns to step S352. As a result, in step S352, as shown in FIG. 8, function numbers <A-4> and <A-7> are read from the function
この結果、ステップS353では、図11に示す変更箇所記憶部122の内容から、関数番号<A−4>の前にバツ「×」を付けて「削除」を表示する。関数番号<A−7>についても、その前にバツ「×」を付けて「削除」の注釈を埋め込む。
As a result, in step S353, “Delete” is displayed by adding “X” in front of the function number <A-4> from the contents of the change
これ以後も、処理する次の段落がマニュアルに存在する限り(ステップS354:N)、変数Dを順にカウントアップしながら(ステップS355)、ステップS352以降の処理を実行する。このようにして、図8に示す関数関係記憶部121の最後の段落の番号「null」まで「区分」を表わす注釈の埋め込みの処理が終了したら(ステップS345:Y)、マニュアルデータの出力処理の前半の処理が終了する(エンド)。
Thereafter, as long as the next paragraph to be processed exists in the manual (step S354: N), the processing after step S352 is executed while sequentially counting up the variable D (step S355). In this way, when the processing for embedding the annotation representing “section” is completed up to the number “null” of the last paragraph in the function
以上説明した処理は、マニュアルとソフトウェアの整合をチェックするものなので、図17で示したようにマニュアル側の段落を最初から最後まで順に進めながらチェックする必要は必ずしもない。すなわち、図11に示した改変箇所リストである変更箇所記憶部122における関数番号<A−1>から、次は関数番号<A−4>というように関数番号を順に呼び出すという処理のプロセスも可能である。
Since the processing described above is for checking the consistency between the manual and the software, it is not always necessary to check the manual side paragraphs in order from the beginning to the end as shown in FIG . That is, the process of calling the function numbers in order, such as the function number <A-4>, from the function number <A-1> in the changed
図18は、図17の変形例として変更箇所提示部によるマニュアルデータの出力処理の前半の処理の様子を表わしたものである。図14と共に説明する。 Figure 18 is a flowchart showing a state of the processing of the first half of the output processing of the manual data by changing position presenting unit as a modification of FIG. 17. This will be described with reference to FIG .
変更箇所提示部113Aは、各関数番号を順次、変更箇所記憶部122の先頭から読み出すためにその変数Kを初期化する(ステップS371)。この例で初期値としての関数番号は「A−1」となる。そこで変更箇所提示部113Aは、変更箇所記憶部122から関数番号「A−1」を読み出す(ステップS372)。
The changed
変更箇所提示部113Aは、次にこの関数番号「A−1」に対応する区分である「改変」が関数関係記憶部121に存在する箇所をチェックして、関数番号「A−1」が存在する箇所すべての箇所にダブルクォーテーション「“”」を付けて「改変」の注釈を埋め込む(ステップS373)。
Next, the changed
このようにして最初の関数番号「A−1」についての対応付けが終了したら、変更箇所記憶部122のすべての関数番号についての処理が終了して次に処理すべき関数番号が存在しなくなったかをチェックする(ステップS374)。まだ、処理すべき関数番号が存在する場合には(N)、変数Kを次の関数番号に変更する(ステップS375)。そして、ステップS372の処理に進むことになる。図11に示した例では、これにより関数番号「A−4」にバツ「×」を付けた「削除」の注釈の埋め込み処理が行われることになる。以下、同様である。
When the association for the first function number “A-1” is completed in this way, the processing for all the function numbers in the change
変更箇所記憶部122のすべての関数番号についての処理が終了して次に処理すべき関数番号が存在しなくなったら(ステップS374:Y)、マニュアルデータの出力処理の前半の処理が終了する(エンド)。
When the processing for all the function numbers in the changed
以上のようなマニュアルとソフトウェアの整合処理が終了すると、先に説明した関数番号<A−10>を例として挙げたように新ソフトウェアで新たに追加した箇所について、関数関係記憶部121に該当するタグが存在しない。そこで、この場合にはその段落を「new」として、関係する関数番号に追加する。この例では関数番号<A−10>を追加することになる。
When the above-described manual / software matching process is completed, the newly added portion of the new software corresponds to the function
図19は、図17あるいは図18で注釈の埋め込みを行った関数関係記憶部を基にしてマニュアルデータの出力を行うマニュアルデータの出力処理の後半の処理の様子を表わしたものである。図14と共に説明する。 FIG. 19 shows the second half of the manual data output process for outputting manual data based on the function relation storage unit in which the annotations are embedded in FIG . 17 or FIG . This will be described with reference to FIG .
変更箇所提示部113Aは、変更箇所については表現形態を変えてマニュアルの先頭から内容を提示するために、マニュアルの段落についての変数Dを初期化する(ステップS391)。段落の番号は図7に示すように<Name>153に続く括弧記号の「<」および「>」で括った内部154で示されるようになっており、この例で初期値としての段落の番号は「1−1」となる。
The changed
そこで、変更箇所提示部113Aは、段落の番号「1−1」についてのマニュアルの内容が、前記した(1)〜(4)の区分けの結果としての図12に示す内容の「改変」、「削除」、「新規」のいずれかに該当するかをチェックする(ステップS392)。これらのいずれかに該当した場合には(Y)、その段落に対応する表現形式の段落に変更して、マニュアルの表示のためのバッファ領域に格納する(ステップS393)。
Therefore,
具体的には、内容の「改変」の場合には、図13に示したように「改変」を行った箇所について、他の箇所の色(黒色)とは異なる赤色で強調表示するようにしてバッファ領域におけるマニュアルの対応する箇所に格納する。ただし、図13では赤色に着色された箇所を斜字で表示している。また、改変箇所には改変が行われたことを示す「(改変)」という語句が併せて表示されるようにする。 Specifically, in the case of “modification” of the contents, as shown in FIG. 13 , the place where the “modification” is performed is highlighted in red different from the color (black) of other places. Store in the corresponding part of the manual in the buffer area. However, in FIG. 13 , the portions colored in red are displayed in italics. In addition, the word “(modification)” indicating that the modification has been performed is displayed together with the modification part.
内容の「削除」の場合には、マニュアルの該当する箇所が削除されるので、その部分はバッファ領域に格納されない。内容が「新規」の場合には、マニュアルの最後の部分に、「追加あり」と赤色(斜字)で強調表示するようにしてバッファ領域に格納する。 In the case of “deletion” of the contents, since the corresponding part of the manual is deleted, that part is not stored in the buffer area. When the contents are “new”, the contents are stored in the buffer area so that “added” is highlighted in red (slanted letters) at the last part of the manual.
ステップS392で前記した(1)〜(4)の区分けの結果としての図12に示す内容の「改変」、「削除」、「新規」のいずれにも該当しないと判別された場合(ステップS392:N)を次に説明する。この場合には、マニュアルの内容が全く変らないので、その部分のマニュアルを通常形式でバッファ領域に格納する(ステップS394)。 When it is determined in step S392 that none of “modification”, “deletion”, and “new” of the contents shown in FIG. 12 as a result of the classification of (1) to (4) described above is applicable (step S392: N) will be described next. In this case, since the contents of the manual are not changed at all, the manual of the portion is stored in the buffer area in the normal format (step S394).
このようにしてステップS393あるいはステップS394の処理が行われたら、関数関係記憶部121の最終段落まで処理が進んだ結果として次に処理すべき段落がなくなったかを判別する(ステップS395)。次の段落がまだ存在する場合には(N)、変数Dを次の段落の番号「1−2」に変更する(ステップS396)。そしてステップS392に処理を戻す。 When the process of step S393 or step S394 is performed in this way, it is determined whether there is no paragraph to be processed next as a result of the process having progressed to the last paragraph in the function relationship storage unit 121 (step S395). If the next paragraph still exists (N), the variable D is changed to the number “1-2” of the next paragraph (step S396). Then, the process returns to step S392.
関数関係記憶部121の最終段落まで処理が進んだ結果として次に処理すべき段落がなくなった場合には(ステップS395:Y)、新ソフトウェアを反映したマニュアル全体の出力すべき情報がバッファ領域に格納されていることになる。そこで、このバッファ領域に格納されている内容を表示するかプリントアウトすることになる(ステップS397)。以上で変更箇所提示部113Aによる全処理が終了する(エンド)。
When there is no paragraph to be processed next as a result of the processing up to the last paragraph in the function relation storage unit 121 (step S395: Y), information to be output of the entire manual reflecting the new software is stored in the buffer area. Will be stored. Therefore, the contents stored in this buffer area are displayed or printed out (step S397). Thus, the entire process by the changed
以上説明した本発明の第2の実施の形態によれば、マニュアル修正箇所提示システム200の中核となる情報処理装置201を、たとえばパーソナルコンピュータで構成することができる。すなわち、メモリ212に格納されたプログラムをCPU211が実行することで、専用の部品を必要とせず、また各種の改良を容易に行うことができる。
According to the second embodiment of the present invention described above, the
<発明の第3の実施の形態> <Third Embodiment of the Invention>
次に本発明の第3の実施の形態を説明する。 Next, a third embodiment of the present invention will be described.
図20は、本発明の第3の実施の形態によるマニュアル修正箇所提示システムの構成を表わしたものである。本実施の形態のマニュアル修正箇所提示システム400で図14と同一の部分には同一の符号を付しており、これらの説明を適宜省略する。
FIG. 20 shows a configuration of a manual correction location presentation system according to the third exemplary embodiment of the present invention. In the manual correction
第3の実施の形態のマニュアル修正箇所提示システム400は、入力装置101と、出力装置104およびこれらを接続したパーソナルコンピュータ等の情報処理装置201Bとによって構成されている。このうちの情報処理装置201B内のデータ処理部102Bは、タグ読取部111Aおよびソフトウェア比較部112Aの他に、マニュアル比較部401と警告部402を新たに設けている。マニュアル比較部401は、新旧のマニュアルを入力装置101で読み取ったものを比較する。警告部402は、マニュアルの文言が変更されてしまった場合に警告を行う。変更箇所提示部113Bは、警告を変更箇所の提示に併せて行うようになっている。
A manual correction
一方、情報処理装置201B内の記憶装置103Bは、関数関係記憶部121と変更箇所記憶部122の他に、新旧マニュアルの比較結果をリストとして保持するマニュアル比較結果記憶部403を新たに備えている。主制御部213Bは、CPU211と本実施の形態での制御を実現するプログラムを格納したメモリ212Bとを備えている。
On the other hand, the storage device 103B in the information processing apparatus 201B newly includes a manual comparison
以上のような構成の第3の実施の形態のマニュアル修正箇所提示システム400では、新旧のソフトウェアの比較を行うソフトウェア比較部112Aに対応付けて新旧のマニュアルの比較を行う。そして、ソフトウェアの変更が行われなかったにも係わらずマニュアルの文言が変更されてしまった場合に警告を行うようになっている。
In the manual correction
第3の実施の形態のマニュアル修正箇所提示システム400におけるタグ読取部111Aとソフトウェア比較部112Aは、第2の実施の形態のそれらと同一の機能を備えており、第2の実施の形態と同様の機能の実現も可能である。
The
本実施の形態のマニュアル修正箇所提示システム400は、ソフトウェア比較部112Aで新旧のソフトウェアの比較を行った後、マニュアル比較部401が新旧のマニュアルの比較を行う。この処理を次に説明する。
In the manual correction
図21は、新旧マニュアルによるタグの比較処理の前半の様子を表わしたものである。図20と共に説明する。 FIG. 21 shows the first half of tag comparison processing according to the old and new manuals. This will be described with reference to FIG .
まず主制御部213Bは、入力装置101から新旧両マニュアルのデータを入力して、メモリ212Bの図示しない作業用メモリ領域に格納する(ステップS501)。この状態でマニュアル比較部401は旧マニュアルの1段落分のデータを検索する(ステップS502)。そして、この旧マニュアルの1段落分のデータに図7で説明した<Tag>155が存在するかをチェックする(ステップS503)。
First, the main control unit 213B inputs the old and new manual data from the
タグが存在しない場合には(ステップS503:N)、旧マニュアルのデータを最後の段落まで読み取りその処理を行ったかチェックして(ステップS504)、そうでない場合には(N)、ステップS502の処理に戻る。すなわち、旧マニュアルのデータを次の段落分だけ読み取って、タグが存在するかを判別する(ステップS503)。 If the tag does not exist (step S503: N), it is checked whether the old manual data is read up to the last paragraph and the process is performed (step S504). If not (N), the process of step S502 is performed. Return to. That is, the old manual data is read for the next paragraph to determine whether a tag exists (step S503).
このようにして旧マニュアルの最初のタグが見つかったとする(ステップS503:Y)。すると、マニュアル比較部401は同じタグを持つ段落を新マニュアルの先頭から順に探していく(ステップS505)。その段落が新マニュアルの最後に到達するまでに見つかれば(ステップS506:Y)、タグの内容を比較する(ステップS507)。その結果が一致すれば(ステップS508:Y)、新マニュアルに移行するに際してその段落に何らの変更もなかったことになる。
It is assumed that the first tag of the old manual is found in this way (step S503: Y). Then, the
そこで、この場合には旧マニュアルの次のタグを探すことになる。すなわち、旧マニュアルの段落を最後まで読み取りその処理を行ったかチェックして(ステップS504)、最後まで読み取っていないのであればステップS502に処理を戻す。そして、旧マニュアルで次のタグを探すことになる。 Therefore, in this case, the next tag in the old manual is searched. That is, it is checked whether the paragraph of the old manual has been read to the end (step S504), and if it has not been read to the end, the process returns to step S502. Then, look for the next tag in the old manual.
一方、ステップS506で旧マニュアルの最初のタグに対する同一のタグが新マニュアルの最後の段落まで見つからなかったとする(N)。この場合には、旧マニュアルのその最初のタグは新マニュアルで削除されたことになる。そこで、この新マニュアルに存在しなかった関数番号については、改変箇所リストであるマニュアル比較結果記憶部403に区分を「削除」として書き込む(追加する)(ステップS509)。そして、旧マニュアルにおける次のタグを探す作業に取りかかることになる。すなわち、旧マニュアルの段落を最後まで処理したかをチェックして(ステップS504)、最後まで処理していないのであればステップS502に処理を戻す。このようにして、旧マニュアルで次のタグを探すことになる。
On the other hand, in step S506, it is assumed that the same tag for the first tag of the old manual is not found until the last paragraph of the new manual (N). In this case, the first tag in the old manual is deleted in the new manual. Therefore, the function number that did not exist in the new manual is written (added) as “deleted” in the manual comparison
もう一つ残った処理として、旧マニュアルの最初のタグと新マニュアルのそれを比較した結果が一致しなかった場合の取り扱いがある。タグの内容が不一致であった場合には(ステップS508:N)、新マニュアルの該当する段落の内容が変更されたことになる。そこでこの場合には、該当する関数番号について改変箇所リストであるマニュアル比較結果記憶部403に区分を「改変」として書き込む(追加する)(ステップS510)。そして、旧マニュアルにおける次のタグを探す作業に取りかかることになる。すなわち、前記したと同様に旧マニュアルの段落を最後まで処理したかをチェックして(ステップS504)、最後まで処理していないのであれば(N)、ステップS502に処理を戻す。このようにして、旧マニュアルで次のタグを探すことになる。
Another remaining process is handling when the result of comparing the first tag of the old manual with that of the new manual does not match. If the contents of the tag do not match (step S508: N), the contents of the corresponding paragraph in the new manual are changed. Therefore, in this case, the classification is written (added) as “modified” in the manual comparison
以上のようにして旧マニュアルの最後の段落まで処理するまでは(ステップS504:N)、旧マニュアルのタグを順に見つけては、これが新マニュアルのタグとしてどうなかったかを調べていく。旧マニュアルの最後の段落までその処理を終了したら(ステップS504:Y)、新マニュアルに存在する残りの関数を「新規」として改変箇所リストであるマニュアル比較結果記憶部403に書き込む(追加する)(ステップS511)。そして、新旧のマニュアル同士によるタグ比較処理の前半の処理を終了する(エンド)。
Until the last paragraph of the old manual is processed as described above (step S504: N), the tags of the old manual are found in order, and it is checked whether this is a tag of the new manual. When the processing is completed up to the last paragraph of the old manual (step S504: Y), the remaining functions existing in the new manual are written (added) as “new” in the manual comparison
図22は、新旧マニュアルによるタグの比較処理の後半の様子を表わしたものである。図20と共に説明する。 FIG. 22 shows the second half of the tag comparison process according to the old and new manuals. This will be described with reference to FIG .
図21による処理を終了したら、マニュアル比較部401は新マニュアルの段落についての変数Dを初期化する(ステップS531)。段落の番号は図7に示すように<Name>153に続く括弧記号の「<」および「>」で括った内部154で示されるようになっており、この例で初期値としての段落の番号は「1−1」となる。
When the process of FIG. 21 is completed, the
次にマニュアル比較部401はマニュアル比較結果記憶部403から第Dの段落の区分を読み出す(ステップS532)。この区分が「改変」ではない場合(ステップS533:N)、警告の対象となる段落とはならない。そこで、この場合にはマニュアル比較結果記憶部403に次の段落が存在しないかどうかをチェックして(ステップS534)、段落が存在すれば(N)、変数Dの値を次の段落に変更する(ステップS535)。そして、処理をステップS533に戻す。
Next, the
一方、ステップS533でマニュアル比較部401が区分を「改変」であると判別した場合には(Y)、変更箇所記憶部122から「改変」のあった関数を1つずつチェックする(ステップS536)。その結果、新ソフトウェアで「改変」とされた関数のいずれかが新マニュアルの段落に対応する関数と一致しなかった場合(ステップS537:N)、ソフトウェアの改変が行われていない箇所でマニュアルの改変が行われたことになる。そこで、この場合、新マニュアルの段落の該当する区分を「改変」から「警告」に変更する(ステップS538)。そして、次の段落へ処理を進めるためにステップS534に移行する。
On the other hand, when the
これに対してステップS537で新ソフトウェアで「改変」とされた関数のいずれかが新マニュアルの段落に対応する関数と一致した場合には(Y)、新マニュアルの段落の該当する区分を「改変」から「警告」に変更する必要がない。そこで、この場合にはそのまま処理をステップS534に移行させる。 On the other hand, if any of the functions “modified” in the new software in step S537 matches the function corresponding to the paragraph of the new manual (Y), the corresponding category of the paragraph of the new manual is “modified”. ”To“ Warning ”. Therefore, in this case, the process proceeds to step S534 as it is.
以上のようにしてマニュアル比較部401が新マニュアルの段落のすべての確認を行ったら(ステップS534:Y)、図22に示した処理を終了する(エンド)。
When the
図23は、マニュアル比較結果記憶部の記憶内容の一例を示したものである。マニュアル比較結果記憶部403には、関数番号に対応させて区分が記されているが、関数番号の代わりに段落が記されてもよい。図23に示した例では、関数番号「E−1」の区分が当初は「改変」であったが、図22で説明した処理によって「警告」に変更されている。
FIG. 23 shows an example of the contents stored in the manual comparison result storage unit. In the manual comparison
図24は、変更箇所提示部による警告を伴う出力処理の後半を表わしたものであり、第2の実施の形態における図19に対応するものである。したがって、図24で図19と対応する部分には図19で記したステップ番号と同一のステップ番号を記しており、これらの説明を適宜省略する。図20と共に説明する。 FIG. 24 shows the latter half of the output process accompanied by the warning by the changed part presenting unit, and corresponds to FIG. 19 in the second embodiment. Therefore, in FIG. 24 , the same step number as the step number shown in FIG. 19 is described in the part corresponding to FIG. 19, and description thereof will be omitted as appropriate. This will be described with reference to FIG .
第3の実施の形態のマニュアル修正箇所提示システム400では、ステップS392で前記した(1)〜(4)の区分けの結果としての図12に示す内容の「改変」、「削除」、「新規」のいずれにも該当しないと判別された場合(ステップS392:N)の処理が第2の実施の形態と異なる。この場合には、変更箇所提示部113Bがその段落が「警告」に区分されているかをチェックする(ステップS551)。
In the manual correction
その段落が「警告」に区分されている場合には(ステップS551:Y)、その段落を「警告」を行う場合について定めた表現形式に変更して、マニュアルの表示のためのバッファ領域に格納する(ステップS552)。そして、ステップS395の処理に進む。 If the paragraph is classified as “warning” (step S551: Y), the paragraph is changed to an expression format determined for performing “warning” and stored in a buffer area for manual display. (Step S552). Then, the process proceeds to step S395.
ステップS551でその段落が「警告」に区分されていない場合には(N)、マニュアルの内容が全く変らないので、その部分のマニュアルを通常形式でバッファ領域に格納する(ステップS394)。そして、ステップS395の処理に進むことになる。 If the paragraph is not classified as “warning” in step S551 (N), the contents of the manual are not changed at all, so the manual for that part is stored in the buffer area in the normal format (step S394). Then, the process proceeds to step S395.
関数関係記憶部121の最終段落まで処理が進んだ結果として次に処理すべき段落がなくなった場合には(ステップS395:Y)、新ソフトウェアを反映したマニュアル全体の出力すべき情報がバッファ領域に格納されていることになる。そこで、このバッファ領域に格納されている内容を表示するかプリントアウトすることになる(ステップS397)。以上で変更箇所提示部113Bによる全処理が終了する(エンド)。
When there is no paragraph to be processed next as a result of the processing up to the last paragraph in the function relation storage unit 121 (step S395: Y), information to be output of the entire manual reflecting the new software is stored in the buffer area. Will be stored. Therefore, the contents stored in this buffer area are displayed or printed out (step S397). Thus, the entire process by the changed
図25は、図13に対応するもので、本実施の形態の出力装置における出力内容の一例として図12に対応するものを示している。新旧のソフトウェアの変更に関係なく追加された段落には、「ソフトウェア変更なし 内容を確認すること(警告)」という文字が赤色等の強調する表現形式で出力されている。ただし、図25ではこの警告用に着色された箇所を他の注意すべき箇所と同様に斜字で表示している。 Figure 25, which corresponds to FIG. 13 shows those corresponding to FIG. 12 as an example of the output content in the output device of the present embodiment. In the paragraph added regardless of changes in the old and new software, the words “Check the contents without software change (warning)” are output in an emphasis format such as red. However, in FIG. 25 , the portions colored for warning are displayed in italics like the other portions to be noted.
以上説明した第3の実施の形態によれば、新旧のソフトウェアで存在しない関数番号のタグが新マニュアルのデータに存在したとき、マニュアルの該当個所で警告を表示するようにした。したがって、新マニュアルの作成前の指針を表示するだけでなく、新マニュアルの作成後の点検にも役立つことになる。 According to the third embodiment described above, when a tag with a function number that does not exist in the old and new software exists in the data of the new manual, a warning is displayed at the corresponding part of the manual. Therefore, not only the guideline before the creation of the new manual is displayed, but also the inspection after the creation of the new manual is useful.
<発明の第4の実施の形態> <Fourth Embodiment of the Invention>
次に本発明の第4の実施の形態を説明する。 Next, a fourth embodiment of the present invention will be described.
図26は、本発明の第4の実施の形態によるマニュアル修正箇所提示システムの構成を表わしたものである。本実施の形態のマニュアル修正箇所提示システム600で図14と同一の部分には同一の符号を付しており、これらの説明を適宜省略する。
FIG. 26 shows the configuration of a manual correction location presentation system according to the fourth exemplary embodiment of the present invention. In the manual correction
第4の実施の形態のマニュアル修正箇所提示システム600は、入力装置101と、出力装置104およびこれらを接続したパーソナルコンピュータ等の情報処理装置201Cとによって構成されている。このうちの情報処理装置201C内のデータ処理部102Cは、タグ読取部111Aおよびソフトウェア比較部112Aの他に、マニュアル比較部401を備えている。マニュアル比較部401は、新旧のマニュアルを入力装置101で読み取ったものを比較する。
A manual correction
一方、情報処理装置201C内の記憶装置103Cは、関数関係記憶部121と変更箇所記憶部122およびマニュアル比較結果記憶部403Cの他に、新たに履歴一覧表記憶部602を備えている。マニュアル比較結果記憶部403Cは新旧マニュアルの比較結果をリストとして保持する。履歴一覧表記憶部602はマニュアルの変更の履歴を保持し、要求に応じてその内容をデータ処理部102Cの変更箇所提示部113Cに出力するようになっている。変更箇所提示部113Cは、第1および第2の実施の形態と同様の処理を行う他に、履歴一覧表記憶部602の記憶内容をテキストファイルで履歴一覧表として出力することができる。主制御部213Cは、CPU211と本実施の形態での制御を実現するプログラムを格納したメモリ212Cとを備えている。
On the other hand, the
本実施の形態では、タグ読取部111Aとソフトウェア比較部112Aおよびマニュアル比較部401を備えている。これらの各部は第3の実施の形態と同様の動作を行う。ただし、第4の実施の形態では第3の実施の形態のマニュアル修正箇所提示システム400で備えていた警告部402を備えていないので、マニュアルの改定に伴う警告は表示しない。もちろん、システムによってはこのような警告を出力することは可能である。
In the present embodiment, a
図27は、本実施の形態のマニュアル修正箇所提示システムで履歴一覧表を出力する処理の流れを表わしたものである。この図27では、第3の実施の形態において図22で説明した新旧マニュアルによるタグ比較処理が終了しており、その結果がリストとしてマニュアル比較結果記憶部403に保持されているものとする。図26と共に説明する。
FIG. 27 shows the flow of processing for outputting a history list in the manual correction location presentation system of the present embodiment. In FIG. 27 , it is assumed that the tag comparison processing by the old and new manuals described in FIG. 22 in the third embodiment has been completed, and the result is held in the manual comparison
まず、変更箇所提示部113Cは、新マニュアルの段落についての変数Dを初期化する(ステップS701)。段落の番号は図7に示すように<Name>153に続く括弧記号の「<」および「>」で括った内部154で示されるようになっており、この例で初期値としての段落の番号は「1−1」となる。
First, the changed
そこで、変更箇所提示部113Cは、第D段落(この場合には段落の番号「1−1」の段落)についての新マニュアルのデータを入力して(ステップS702)、履歴一覧表記憶部602に第D段落が存在するかを検索する(ステップS703)。履歴一覧表記憶部602には、旧マニュアルあるいはそれ以前に作成されたマニュアルについての履歴が段落ごとに記載されている。したがって、この履歴一覧表記憶部602に第D段落と同一の段落が存在するかを調べることになる。
Therefore, the changed
検索の結果、第D段落が存在すると判別された場合には(ステップS704:Y)、履歴一覧表記憶部602における現在の記載に、今回の新旧マニュアルの比較結果としてマニュアル比較結果記憶部403Cに記載されている内容を記録として追加する(ステップS705)。第D段落がマニュアル比較結果記憶部403Cに記載されていない場合には(ステップS704:N)、第D段落の項目を追加して、記録を追加する(ステップS706)。これらの記録の追加には、新マニュアルに移行した日時も記載の対象となる。
As a result of the search, if it is determined that the Dth paragraph exists (step S704: Y), the current description in the history
このようにして新マニュアルの第D段落についての履歴をとる処理が終了したら、新マニュアルに次の段落が存在せず、マニュアルの処理が終了したかをチェックする(ステップS707)。まだ処理すべき段落が存在する場合には(N)、変数Dを次の段落の値に変更して(ステップS708)、ステップS702の処理に戻る。 When the process for obtaining the history of the Dth paragraph of the new manual is completed in this way, it is checked whether the next paragraph does not exist in the new manual and the manual process is completed (step S707). If there is still a paragraph to be processed (N), the variable D is changed to the value of the next paragraph (step S708), and the process returns to step S702.
このようにして新マニュアルについてのすべての段落の処理が終了したら(ステップS707:Y)、現在の履歴一覧表記憶部602の内容を基にして変更箇所提示部113Cがメモリ212Cの所定の作業領域に履歴一覧表を作成する(ステップS709)。履歴一覧表の作成にあたっては、段落の変更や追加、削除の履歴をソフトウェア内の関数の変更に紐付けする。変更箇所提示部113Cは、作成した履歴一覧表を出力装置104に送って(ステップS710)、これを図示しないディスプレイに表示したり、プリントアウトする。テキストファイルとして出力してもよい。
When the processing of all the paragraphs for the new manual is completed in this way (step S707: Y), the change
図28は、出力装置から出力される履歴一覧表の一例を示したものである。この履歴一覧表611を見ることにより、ユーザはソースコードの改変およびマニュアルの改変の対応関係を簡単に確認することができる。ここで「A−1」、「A−2」は関数番号を表わしている。
FIG. 28 shows an example of a history list output from the output device. By viewing the
以上説明した本発明の第4の実施の形態によれば、タグを用いて特定の段落と関係づけることを利用し、修正履歴を一体で管理することができる。また、タグをマニュアルデータおよびソースコードに埋め込むことで、ソースコードの改変およびマニュアルの改変の対応関係を確認することができる。 According to the fourth embodiment of the present invention described above, it is possible to manage the correction history as a whole by utilizing the association with a specific paragraph using a tag. Also, by embedding the tag in the manual data and the source code, it is possible to confirm the correspondence between the source code modification and the manual modification.
なお、以上説明した各実施の形態では、マニュアルについて段落ごとにタグを付すことにしたが、章や節あるいは任意の箇所で文章を区切り、タグを付すようにしてもよい。ソフトウェアについてもタグを付すための単位は特に限定されるものではない。 In each of the embodiments described above, a tag is attached to each paragraph of the manual. However, a sentence may be divided and attached to chapters, sections, or arbitrary places. The unit for tagging software is not particularly limited.
10、100 マニュアル修正箇所提示装置
11、22a ソフトウェア比較手段
12、22b マニュアル読込手段
13、22c ソフトウェア用区分けリスト作成手段
14、22d マニュアル側対応リスト作成手段
15、22e マニュアル変更箇所判別手段
20、200、400、600 マニュアル修正箇所提示システム
21、101 入力装置
22、201、201B、201C 情報処理装置
30 マニュアル修正箇所提示方法
31 ソフトウェア比較ステップ
32 マニュアル読込ステップ
33 ソフトウェア用区分けリスト作成ステップ
34 マニュアル側対応リスト作成ステップ
35 マニュアル変更箇所判別ステップ
40 マニュアル修正箇所提示プログラム
41 ソフトウェア比較処理
42 マニュアル読込処理
43 ソフトウェア用区分けリスト作成処理
44 マニュアル側対応リスト作成処理
45 マニュアル変更箇所判別処理
102、102B、102C データ処理部
103、103B、103C 記憶装置
104 出力装置
111 タグ読取部
112 ソフトウェア比較部
113、113B、113C 変更箇所提示部
121 関数関係記憶部
122 変更箇所記憶部
151 マニュアルの文章
155 <Tag>
181、181B 出力内容
211 CPU
212、212B、212C メモリ
213、213B、213C 主制御部
401 マニュアル比較部
402 警告部
403、403C マニュアル比較結果記憶部
602 履歴一覧表記憶部
611 履歴一覧表
10, 100 Manual correction
181 and
212, 212B,
Claims (8)
ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記ソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込手段と、
前記ソフトウェア比較手段で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記ソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成手段と、
前記マニュアル読込手段で読み込んだ第1のマニュアルの前記マニュアル側識別情報ごとに前記第2のソフトウェアについて前記ソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成手段と、
このマニュアル側対応リスト作成手段で作成したリストにおける前記マニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記第1のソフトウェアから前記第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別手段
とを具備することを特徴とするマニュアル修正箇所提示装置。 A first software in which source code is divided into predetermined units, and software-side identification information uniquely indicating each of the divided areas is embedded in each of the divided locations, and the software-side identification information is embedded in the first software Software comparison means for inputting second software that is a revised version of the software and comparing the respective areas for each piece of software side identification information;
Sentences describing the description of the software are divided in predetermined units, and manual side identification information uniquely indicating each of the divided areas is embedded in each divided place, and the description of each area is written in the software. The first manual corresponding to the first software in which the corresponding one of the software side identification information is embedded in the corresponding manual side identification information corresponding to the source code of which software side identification information corresponds to Manual reading means to read,
As a result of the comparison by the software comparison means for each area, “modification” is applied to an area in which the source code has been changed due to revision, “deletion” is applied to an area in which the corresponding source code has been deleted, When the source code is added, a software classification list creating means for creating a classification list in which “addition” is classified according to each software side identification information;
Manual side correspondence list creating means for creating a list in which the software side identification information is associated with the second software for each manual side identification information of the first manual read by the manual reading means;
In the list created by the manual side correspondence list creating means, all of the source code corresponding to each manual side identification information has been deleted, or at least a part thereof has been modified, or a new one that does not exist in the first software A manual modification portion for determining whether or not the source code of the content is added to the first manual according to the revision from the first software to the second software. Presentation device.
このマニュアル比較手段による前記マニュアル側識別情報ごとの比較結果、改版に伴い文章に改変があった領域には「改変」を、該当する文章が削除された領域には「削除」を、新たな内容の文章が追加されたときには「新規」を、それぞれの前記領域ごとに対応させて区分けした区分けリストを作成するマニュアル用区分けリスト作成手段と、
このマニュアル用区分けリスト作成手段によって「改変」とされた箇所が、前記ソフトウェア用区分けリスト作成手段によって作成された前記区分けリストにおける「改変」とされた箇所のいずれかと一致するかを判別する改変箇所判別手段と、
この改変箇所判別手段によっていずれにも一致しないと判別したとき前記第2のマニュアルの「改変」とされた箇所の記載内容がソフトウェアのソースコードによって支持されていない可能性があるものとして警告を出力する警告出力手段
とを具備することを特徴とする請求項1記載のマニュアル修正箇所提示装置。 The first manual created corresponding to the first software is compared with the second manual created corresponding to the second software obtained by revising the first software for each manual side identification information. Manual comparison means,
As a result of the comparison by the manual side identification information by the manual comparison means, the area where the text has been changed due to the revision is “modified”, the area where the corresponding text is deleted is “deleted”, and the new contents When a new sentence is added, a manual classification list creating means for creating a classification list in which “new” is classified corresponding to each of the areas, and
The modified part for determining whether the part that has been “modified” by the manual classification list creating means matches any of the parts that have been “modified” in the classification list created by the software classification list creating means Discrimination means;
When it is determined by the modified part discriminating means that they do not match any of them, a warning is output on the assumption that there is a possibility that the description content of the “modified” part of the second manual is not supported by the software source code The manual correction location presenting device according to claim 1, further comprising: a warning output means for performing the operation.
このマニュアル比較手段による前記マニュアル側識別情報ごとの比較結果を履歴情報として格納する履歴情報格納手段と、
この履歴情報格納手段に格納された履歴情報を出力する履歴情報出力手段
とを具備することを特徴とする請求項1記載のマニュアル修正箇所提示装置。 The first manual created corresponding to the first software is compared with the second manual created corresponding to the second software obtained by revising the first software for each manual side identification information. Manual comparison means,
History information storage means for storing a comparison result for each manual side identification information by the manual comparison means as history information;
2. The manual correction location presenting apparatus according to claim 1, further comprising history information output means for outputting history information stored in the history information storage means.
前記ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記ソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記ソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較手段と、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記ソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込手段と、前記ソフトウェア比較手段で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記ソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成手段と、前記マニュアル読込手段で読み込んだ第1のマニュアルの前記マニュアル側識別情報ごとに前記第2のソフトウェアについて前記ソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成手段と、このマニュアル側対応リスト作成手段で作成したリストにおける前記マニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記第1のソフトウェアから前記第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別手段とを備えた情報処理装置と、
この情報処理装置の処理結果としてのマニュアル修正箇所に関するデータを出力する出力装置
とを具備することを特徴とするマニュアル修正箇所提示システム。 An input device for inputting software source code and software manual data;
A first software in which the source code is divided into predetermined units, and software-side identification information uniquely indicating each of the divided areas is embedded in each of the divided locations, and the software-side identification information is embedded. Software comparison means for inputting second software that is a revision of one software and comparing the respective areas for each piece of software side identification information; The manual side identification information uniquely indicating each divided area is embedded in each divided place, and the software side indicates which software side identification information of the software corresponds to the description of each area. The corresponding manual of the identification information As a result of comparing each area by the manual reading means for reading the first manual corresponding to the first software embedded in the location of the identification information and the software comparing means, the source code has been changed due to the revision. "Modify" for the area, "Delete" for the area where the corresponding source code has been deleted, and "Add" when a new source code is added for each software side identification information The software side list creating means for creating a sorted list and the software side identification information for the second software is associated with each manual side identification information of the first manual read by the manual reading means. Manual-side list creation means for creating The source code of the part corresponding to each manual side identification information in the list created by the list creating means has been deleted, or at least part of the source code has been modified, or the source code of new contents not existing in the first software An information processing apparatus comprising: manual change location determination means for determining whether the first manual has been added in accordance with the revision from the first software to the second software;
A manual correction location presentation system comprising: an output device that outputs data relating to a manual correction location as a processing result of the information processing apparatus.
前記CPUにより機能的に実現するマニュアル読込手段によって、ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記ソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記第1のソフトウェアに対応する第1のマニュアルを前記マニュアル修正箇所提示装置に読み込むマニュアル読込ステップと、
前記ソフトウェア比較ステップで領域ごとに比較した結果、前記CPUにより機能的に実現するソフトウェア用区分けリスト作成手段によって改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記ソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成ステップと、
前記マニュアル読込ステップで読み込んだ第1のマニュアルの前記マニュアル側識別情報ごとに前記CPUにより機能的に実現するマニュアル側対応リスト作成手段によって前記第2のソフトウェアについて前記ソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成ステップと、
このマニュアル側対応リスト作成ステップで作成したリストにおける前記マニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記CPUにより機能的に実現するマニュアル変更箇所判別手段によって前記第1のソフトウェアから前記第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別ステップ
とを具備することを特徴とするマニュアル修正箇所提示方法。 CPU by functionally implemented software comparing means by (Central Processing Unit) to execute a predetermined application software, delimit the source code in a predetermined unit, the software side identification indicating these separated respective regions unique The first software in which information is embedded in each divided place and the second software in which the first software in which the software side identification information is embedded are revised are input to the manual correction location presentation device provided with the CPU. A software comparison step for comparing the respective areas for each software side identification information,
The manual reading means functionally realized by the CPU divides the text describing the software description contents into predetermined units, and places the manual side identification information uniquely indicating the divided areas. In addition, the corresponding software-side identification information corresponding to the source code of the software-side identification information of the software is embedded in the corresponding manual-side identification information. A manual reading step of reading the first manual corresponding to the first software into the manual correction location presenting device ;
As a result of comparison for each area in the software comparison step, the area where the source code has been changed due to the revision by the software classification list creating means functionally realized by the CPU is changed to “modified”, and the corresponding source code is A software sorting list that creates a sorting list in which “deleted” is added to the deleted area, and “added” is added when a source code having a new content is added, corresponding to each software side identification information. Creation steps,
A list in which the software-side identification information is associated with the second software by the manual-side correspondence list creating means functionally realized by the CPU for each manual-side identification information of the first manual read in the manual reading step. Manual side list creation step to create
In the list created in the manual side correspondence list creation step, the source code of the portion corresponding to each manual side identification information in the list has been deleted, or at least a part thereof has been modified, or a new one that does not exist in the first software Manual change location where the first manual is discriminated with the revision from the first software to the second software by means of manual change location discriminating means that functionally realizes whether the source code of the contents has been added by the CPU. A manual correction location presenting method comprising: a discrimination step.
ソースコードを所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すソフトウェア側識別情報をそれぞれの区切った場所に埋め込んだ第1のソフトウェアと、前記ソフトウェア側識別情報を埋め込んだ第1のソフトウェアを改版した第2のソフトウェアをそれぞれ入力して前記ソフトウェア側識別情報ごとにそれぞれの領域を比較するソフトウェア比較処理と、
ソフトウェアの記述内容を記した文章を所定の単位で区切って、これら区切られたそれぞれの領域を一意で示すマニュアル側識別情報をそれぞれの区切った場所に埋め込むと共に、それぞれの領域の記載が前記ソフトウェアのどのソフトウェア側識別情報のソースコードと対応するかをこれらのソフトウェア側識別情報のうちの該当するものを対応するマニュアル側識別情報の箇所に埋め込んだ前記第1のソフトウェアに対応する第1のマニュアルを読み込むマニュアル読込処理と、
前記ソフトウェア比較処理で領域ごとに比較した結果、改版に伴いソースコードに改変があった領域には「改変」を、該当するソースコードが削除された領域には「削除」を、新たな内容のソースコードが追加されたときには「追加」を、それぞれの前記ソフトウェア側識別情報ごとに対応させて区分けした区分けリストを作成するソフトウェア用区分けリスト作成処理と、
前記マニュアル読込処理で読み込んだ第1のマニュアルの前記マニュアル側識別情報ごとに前記第2のソフトウェアについて前記ソフトウェア側識別情報を対応付けたリストを作成するマニュアル側対応リスト作成処理と、
このマニュアル側対応リスト作成処理で作成したリストにおける前記マニュアル側識別情報ごとに対応する箇所のソースコードがすべて削除されたか、少なくとも一部が改変されたか、あるいは前記第1のソフトウェアに存在しない新たな内容のソースコードが追加されたかを前記第1のソフトウェアから前記第2のソフトウェアへの改版に伴って第1のマニュアルについて判別するマニュアル変更箇所判別処理
とを実行させることを特徴とするマニュアル修正箇所提示プログラム。 On the computer,
A first software in which source code is divided into predetermined units, and software-side identification information uniquely indicating each of the divided areas is embedded in each of the divided locations, and the software-side identification information is embedded in the first software A software comparison process in which the second software is updated and the respective areas are compared for each piece of software-side identification information;
Sentences describing the description of the software are divided in predetermined units, and manual side identification information uniquely indicating each of the divided areas is embedded in each divided place, and the description of each area is written in the software. The first manual corresponding to the first software in which the corresponding one of the software side identification information is embedded in the corresponding manual side identification information corresponding to the source code of which software side identification information corresponds to Manual reading process to read,
As a result of comparison for each area in the software comparison process, “modification” is applied to an area in which the source code has been changed due to the revision, “deletion” is applied to an area in which the corresponding source code has been deleted, When the source code is added, “addition” is a software classification list creation process for creating a classification list that is classified according to each software side identification information;
A manual side correspondence list creating process for creating a list in which the software side identification information is associated with the second software for each manual side identification information of the first manual read in the manual reading process;
In the list created by the manual side correspondence list creation process, all the source codes corresponding to each manual side identification information have been deleted, or at least part of the source code has been modified, or a new one that does not exist in the first software A manual correction portion for executing manual change portion determination processing for determining whether or not the source code of the content has been added for the first manual in accordance with the revision from the first software to the second software Presentation program.
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
JP2010020357A JP5150657B2 (en) | 2010-02-01 | 2010-02-01 | Manual correction location presentation device, system, method and program |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
JP2010020357A JP5150657B2 (en) | 2010-02-01 | 2010-02-01 | Manual correction location presentation device, system, method and program |
Publications (2)
Publication Number | Publication Date |
---|---|
JP2011159112A JP2011159112A (en) | 2011-08-18 |
JP5150657B2 true JP5150657B2 (en) | 2013-02-20 |
Family
ID=44591006
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
JP2010020357A Expired - Fee Related JP5150657B2 (en) | 2010-02-01 | 2010-02-01 | Manual correction location presentation device, system, method and program |
Country Status (1)
Country | Link |
---|---|
JP (1) | JP5150657B2 (en) |
Families Citing this family (3)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
JP6191440B2 (en) * | 2013-12-18 | 2017-09-06 | 富士通株式会社 | Script management program, script management apparatus, and script management method |
JP6519137B2 (en) * | 2014-09-30 | 2019-05-29 | 富士通株式会社 | Estimation program, estimation apparatus and estimation method |
CN109672916B (en) * | 2018-12-29 | 2022-03-11 | 深圳Tcl新技术有限公司 | Information source switching method, television and storage medium |
Family Cites Families (5)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
JPH05298081A (en) * | 1992-04-20 | 1993-11-12 | Omron Corp | Specification extracting device |
JP2000112743A (en) * | 1998-09-30 | 2000-04-21 | Hitachi Software Eng Co Ltd | Program correcting information managing method |
JP2002189593A (en) * | 2000-12-21 | 2002-07-05 | Mitsubishi Electric Corp | Effect range extraction system, effect range extraction method and computer readable recording medium having program recorded thereon |
JP2002366354A (en) * | 2001-06-05 | 2002-12-20 | Fujitsu Ltd | Method, device, and program for generating program specification |
JP2008123432A (en) * | 2006-11-15 | 2008-05-29 | Hitachi Ltd | Software asset management system |
-
2010
- 2010-02-01 JP JP2010020357A patent/JP5150657B2/en not_active Expired - Fee Related
Also Published As
Publication number | Publication date |
---|---|
JP2011159112A (en) | 2011-08-18 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
US6098071A (en) | Method and apparatus for structured document difference string extraction | |
US8380650B2 (en) | Information extraction rule making support system, information extraction rule making support method, and information extraction rule making support program | |
JP4682284B2 (en) | Document difference detection device | |
CN108762743B (en) | Data table operation code generation method and device | |
US10698937B2 (en) | Split mapping for dynamic rendering and maintaining consistency of data processed by applications | |
JP4502615B2 (en) | Similar sentence search device, similar sentence search method, and program | |
WO1998008168A1 (en) | Original text generating apparatus and its program storage medium | |
US11790162B2 (en) | Information processing apparatus and non-transitory computer readable medium storing program | |
US20150347398A1 (en) | Translation assistance device, translation assistance system, and control method for the same | |
US20210174013A1 (en) | Information processing apparatus and non-transitory computer readable medium storing program | |
US6175843B1 (en) | Method and system for displaying a structured document | |
JP4815934B2 (en) | Text mining device, text mining method, text mining program | |
JP5150657B2 (en) | Manual correction location presentation device, system, method and program | |
CN112925879A (en) | Information processing apparatus, storage medium, and information processing method | |
JP5747698B2 (en) | Requirements management support device | |
JP5273884B1 (en) | Structure analysis apparatus and program | |
JP7207675B1 (en) | Description input support method and program | |
JP2008112363A (en) | Document processor and document processing program | |
JP5091549B2 (en) | Document data processing device | |
CN113177391B (en) | Method for redirecting operation cursor in streaming interface, computing equipment and storage medium | |
JP6710881B1 (en) | Document creation support system | |
JPH08221417A (en) | New/old comparing editing device for structured document | |
JP2005309723A (en) | Automatic design system and automatic design method and automatic design program | |
JPWO2006001391A1 (en) | Document processing apparatus and document processing method | |
JP6475288B2 (en) | Program comparison method, program comparison device, and program comparison program |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
A621 | Written request for application examination |
Free format text: JAPANESE INTERMEDIATE CODE: A621 Effective date: 20110314 |
|
A977 | Report on retrieval |
Free format text: JAPANESE INTERMEDIATE CODE: A971007 Effective date: 20120801 |
|
A131 | Notification of reasons for refusal |
Free format text: JAPANESE INTERMEDIATE CODE: A131 Effective date: 20120807 |
|
A521 | Request for written amendment filed |
Free format text: JAPANESE INTERMEDIATE CODE: A523 Effective date: 20121003 |
|
RD01 | Notification of change of attorney |
Free format text: JAPANESE INTERMEDIATE CODE: A7421 Effective date: 20121022 |
|
TRDD | Decision of grant or rejection written | ||
A01 | Written decision to grant a patent or to grant a registration (utility model) |
Free format text: JAPANESE INTERMEDIATE CODE: A01 Effective date: 20121120 |
|
A61 | First payment of annual fees (during grant procedure) |
Free format text: JAPANESE INTERMEDIATE CODE: A61 Effective date: 20121203 |
|
R150 | Certificate of patent or registration of utility model |
Ref document number: 5150657 Country of ref document: JP Free format text: JAPANESE INTERMEDIATE CODE: R150 Free format text: JAPANESE INTERMEDIATE CODE: R150 |
|
FPAY | Renewal fee payment (event date is renewal date of database) |
Free format text: PAYMENT UNTIL: 20151207 Year of fee payment: 3 |
|
S111 | Request for change of ownership or part of ownership |
Free format text: JAPANESE INTERMEDIATE CODE: R313111 |
|
R350 | Written notification of registration of transfer |
Free format text: JAPANESE INTERMEDIATE CODE: R350 |
|
LAPS | Cancellation because of no payment of annual fees |