JPH11184687A - Software document creation system using hierarchical structure and relation of software document and its operation method - Google Patents
Software document creation system using hierarchical structure and relation of software document and its operation methodInfo
- Publication number
- JPH11184687A JPH11184687A JP10035498A JP3549898A JPH11184687A JP H11184687 A JPH11184687 A JP H11184687A JP 10035498 A JP10035498 A JP 10035498A JP 3549898 A JP3549898 A JP 3549898A JP H11184687 A JPH11184687 A JP H11184687A
- Authority
- JP
- Japan
- Prior art keywords
- document
- hierarchy
- software
- documents
- information
- 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.)
- Pending
Links
Classifications
-
- G—PHYSICS
- G06—COMPUTING OR CALCULATING; COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
Landscapes
- Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Theoretical Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Engineering & Computer Science (AREA)
- General Physics & Mathematics (AREA)
- Stored Programmes (AREA)
- Document Processing Apparatus (AREA)
Abstract
(57)【要約】
【課題】 ソフトウェア開発過程で生成される産出物で
ある各種文書を易しく作成しこれを一貫性よく維持し管
理し得るソフトウェア文書の階層構造及び関係を用いる
ソフトウェア文書作成システム及びその運用方法を提供
する。
【解決手段】 文書内容間の連関関係を文書の章と節,
節と段落,段落と段落間の関係等に階層的に易しく定義
しつつ文書を作成し得る装置を備え、このような連関関
係を下位階層の連関関係の変化によって上位階層で自動
に関係を生成し、変更,削除時にもこれを維持し得るよ
うにする関係管理装置を備える。このような文書を一つ
一つ始めから作成しなくてもよいように予め作成された
テンプレートを提供し、これにより文書を修正しつつ易
しく作成し得る構成とする。
(57) [Summary] [PROBLEMS] A software document creation system using a hierarchical structure and relationships of software documents capable of easily creating various documents, which are products generated in a software development process, and maintaining and managing these documents with consistency. Provide the operation method. SOLUTION: The association between document contents is described by a chapter and a section of the document.
Equipped with a device that can create a document while easily defining the sections and paragraphs, the relations between paragraphs, etc. in a hierarchical manner, and automatically generating such associations in the upper hierarchy by changing the associations in the lower hierarchy. In addition, a relationship management device is provided which can maintain the same even when it is changed or deleted. A template created in advance is provided so that it is not necessary to create such documents one by one from the beginning, so that the document can be easily created while correcting the document.
Description
【0001】[0001]
【発明の属する技術分野】本発明はソフトウェア文書の
階層構造及び関係を用いるソフトウェア文書作成システ
ム及びその運用方法に関し、特にソフトウェア開発プロ
ジェクトで発生する文書を作成,貯蔵,検索するに際
し、文書の階層構造を定義し、階層間の依存性(あるい
は関連性)を表現し管理して文書を易しく作成するとが
できるとともに各文書間に一貫性をもたせて維持管理す
ることができるソフトウェア文書の階層構造及び関係を
用いるソフトウェア文書作成システムとその運用方法の
技術にに関する。BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a software document creating system using a hierarchical structure and relation of software documents and an operating method thereof, and more particularly, to creating, storing, and retrieving a document generated in a software development project, the hierarchical structure of the document. , And expresses and manages the dependencies (or relevance) between hierarchies so that documents can be created easily, and the hierarchical structure and relationships of software documents that can be maintained and maintained with consistency between documents The present invention relates to a software document creation system and a technology for operating the software document.
【0002】[0002]
【従来の技術】一般に、ソフトウェア開発過程では、開
発及び管理目的として作成され、または契約上の必要か
ら、必須的に利用すべき多種類の文書が発生する。例え
ば、提案書,契約書,要求事項定義書,分析明細書,設
計明細書,試験計画書,試験結果書等の書類である。こ
のような様々な類型のソフトウェア文書を作成し、管理
することは相当な経験と努力を必要とする。特に、この
ようなソフトウェア文書は、内容面で関連することが多
い。例えば、要求事項定義書の性能要求事項は設計時に
特定装置に連結されて、この実現過程において特定装置
及びプログラムにより具現化される。また、試験過程で
は、この装置及びプログラムの試験を行うための試験計
画及び試験結果報告が要求される。このような関連性
は、ソフトウェアの修正,変更,維持補修時において、
文書間の一貫性を維持するのに多くの困難がともなう原
因となっている。2. Description of the Related Art Generally, in a software development process, there are various types of documents that are created for development and management purposes, or that are indispensable for contract purposes. For example, it is a document such as a proposal, a contract, a requirement definition, an analysis specification, a design specification, a test plan, and a test result. Creating and managing these various types of software documentation requires considerable experience and effort. In particular, such software documents are often content related. For example, the performance requirements of the requirement definition document are connected to a specific device at the time of design, and are embodied by the specific device and a program in the realization process. In the test process, a test plan and a test result report for testing the device and the program are required. Such relevance may arise when modifying, changing, maintaining, or repairing the software.
This causes many difficulties in maintaining consistency between documents.
【0003】また、文書中の内容が変更される場合に、
関連文書を追跡して変更することにより各文書間の一貫
性を維持することができるが、ほとんどのソフトウェア
の開発過程においてこのように一貫性を維持しつつ文書
を作成し変更することは難しい状況にある。このために
文書化支援のための道具が必要となる。この点について
の従来のソフトウェア文書化管理装置を見ると、米国を
中心とする先進国ではすでにCASE(Computer Aided
Software Engineering) 道具を中心として多くのソフト
ウェア開発支援道具が開発され、この開発に基づく製品
が安定的に使用される状況にある。[0003] When the contents of a document are changed,
Tracking and changing related documents can maintain consistency between documents, but it is difficult to create and change documents while maintaining such consistency in most software development processes. It is in. For this purpose, tools for supporting documentation are required. Looking at the conventional software documentation management device in this regard, the developed countries, especially the United States, already have CASE (Computer Aided
Software Engineering) Many software development support tools, mainly tools, have been developed, and products based on this development are in stable use.
【0004】しかしながら、このような支援道具は、応
用プログラム及びデータベース構築支援を目的とする支
援道具であり、付随的に文書化機能を支援している形態
であるために、満足できる水準の文書化支援道具とはな
っていない。すなわち、分析及び設計,プログラミング
された内容に基づいてその内容を把握し、以後の維持補
修のための技術的文書を生成するようになっているため
に、実際に開発過程における生成物としての各種文書
(明細書,計画書,結果報告書形態等)の作成を助ける
文書化支援道具とはなっていない問題がある。[0004] However, such a support tool is a support tool for supporting the construction of an application program and a database, and has a form of supporting a documentation function. Therefore, a satisfactory level of documentation is provided. It is not a support tool. In other words, since the contents are grasped based on the contents analyzed, designed, and programmed, and technical documents for subsequent maintenance and repair are generated, various kinds of products as actual products in the development process are created. There is a problem that it is not a documentation support tool to help create documents (specifications, plans, result report format, etc.).
【0005】特に、ほとんどの支援道具が特定ソフトウ
ェアの開発方法論に従属しているために、異なる開発方
法論によるプロジェクトではそれに合った支援道具を使
用することになる不便が伴い、文書間の依存性を表現し
管理して一貫性ある文書の作成を支援する機能はさらに
弱いものがある。また、既存の文書化支援道具で使用さ
れる一貫性維持技法は、概略的には、文書をいくつかの
関連したモジュールの集合と見做し、文書を構成する一
つのモジュール単位でリンクを連結し、モジュール間の
依存関係を表すことにより、文書間の作成または修正時
に参考としたモジュールを表示し検索することができる
ようにしたものである。従って、プロジェクト内での生
命周期または文書の位置は考慮されなく、文書の階層的
な特徴も反映されない。また、間接的な関連を有するモ
ジュールの場合には、モジュールの削除時において、二
つのモジュール間のリンクが無視され、全く無関係なモ
ジュールとなってしまう等の問題点があった。In particular, since most support tools are dependent on a specific software development methodology, projects using different development methodologies have the inconvenience of using the appropriate support tools, and the dependency between documents is reduced. The ability to express and manage to help create consistent documents is even weaker. Also, the consistency maintenance technique used in existing documentation support tools generally considers a document as a set of several related modules, and connects links in units of one module that constitutes the document. By indicating the dependency between modules, a module referred to when creating or modifying documents can be displayed and searched. Therefore, the life cycle or the position of the document within the project is not taken into account and the hierarchical characteristics of the document are not reflected. In addition, in the case of a module having an indirect relationship, when deleting a module, the link between the two modules is ignored and the module becomes completely unrelated.
【0006】[0006]
【発明が解決しようとする課題】従って、本発明はこの
ような既存の文書化支援道具の問題点を解決するために
創案されたものであり、ソフトウェアの開発において、
開発方法及び手続きに独立的であり、一貫性維持が可能
である階層構造及び関係を設定しつつソフトウェアを開
発する全産業体(システム統合業者,ソフトウェアハウ
ス,In-house開発者)がソフトウェア開発過程で生成さ
れる産出物である各種文書を易しく作成しこれに一貫性
をもたせて維持し管理することができるソフトウェア文
書の階層構造及び関係を用いるソフトウェア文書作成シ
ステムとその運用方法の提供を目的としている。SUMMARY OF THE INVENTION Accordingly, the present invention has been conceived in order to solve the problems of such existing documentation support tools.
All industrial entities (system integrators, software houses, in-house developers) who develop software while establishing a hierarchical structure and relationships that are independent of development methods and procedures and can maintain consistency are software development processes The purpose of the present invention is to provide a software document creation system using a hierarchical structure and relationships of software documents that can easily create, maintain, and manage the various documents that are the products generated by the above, and provide a method of operating the same. I have.
【0007】[0007]
【課題を解決するための手段】前記目的を達成するため
の本発明の構成及び作用を詳細に説明すると次のようで
ある。本発明の構成はプロジェクト,ソフトウェア生命
周期の段階と段階別生成文書を定義し得る生命周期管理
器(Lifecycle Manager) と、文書間の関係を設定し文書
の個別的構造を設定し文書内容間の関係を設定する関係
管理器(Link Manager)と、文書内容の作成及び貯蔵のた
め内容モジュール編集器(Content Module Editor) と、
閲覧人及び作成者の等級、参照権限付与等を管理する使
用者管理器(User Manager)とから構成されることを特徴
とする。The structure and operation of the present invention for achieving the above object will be described in detail as follows. The structure of the present invention is a life cycle manager (Lifecycle Manager) that can define the stage of the project and the software life cycle and the generated document for each stage, and the relationship between the documents, the individual structure of the document is set, and the A relationship manager (Link Manager) for setting relationships, a content module editor (Content Module Editor) for creating and storing document contents,
It is characterized by comprising a user manager (User Manager) for managing the class of the reader and the creator, the grant of reference authority, and the like.
【0008】その他に本発明は、使用者の入力を助け、
貯蔵された情報を管理し出力を支援する部分で、自動生
成された入力様式を提供する入力フィールド生成器(Inp
ut Field Generator) と、オンライン説明が可能である
ようにする説明生成器(Explanation Generator) と、プ
ロジェクト,生命周期,文書に関する情報と関連情報を
データベースに維持する情報貯蔵所(Repository)と、文
書の検索のためにウェッブラウザを連結して使用し得る
ようにする出力生成器(Output Generator)とから構成さ
れている。In addition, the present invention assists the user in inputting,
An input field generator (Inp.) That manages stored information and supports output, and provides an automatically generated input format.
ut Field Generator), an explanation generator (Explanation Generator) that enables online explanation, an information repository (Repository) that maintains information on the project, life cycle, documents and related information in a database, and a document An output generator for connecting and using a web browser for searching.
【0009】本発明のソフトウェア文書作成システムで
は文書を貯蔵し処理する単位となる文書をツリー構造の
文書モデルで定義することを特徴とする。文書を文字の
集まりと見做す伝統的な観点を取る道具では、文書をフ
ァイルと対応させて全てのオペレーションをファイルま
たは文字単位で遂行するようにするので開発は易しい
が、使用者は文書に関する構造を理解する必要があるこ
とから使用が難しく、さらに文書一つのみを対象として
個別的に管理するため、文書間の依存関係またはプロジ
ェクトでの文書の位置等を管理することが難しいという
問題がある。The software document creation system according to the present invention is characterized in that a document serving as a unit for storing and processing a document is defined by a document model having a tree structure. Tools that take the traditional view of a document as a collection of characters are easier to develop because the document is associated with a file and all operations are performed on a file or character basis, but the user is Since it is necessary to understand the structure, it is difficult to use it.In addition, since only one document is managed individually, it is difficult to manage the dependencies between documents or the position of documents in a project. is there.
【0010】本発明では、文書をツリー構造で表現する
ことにより、章,節,段落等の階層構造をよく表現し得
る。文書ツリーを構成するツリーのノードは、階層情報
と内容モジュールとの二通りに区分される。階層情報ノ
ードは文書の目次に相当する部分で、文書の章,節,段
落等文書の構造を表現する部分である。文書題目をルー
トノードとして章,節,段落の題目がそれぞれ一つのノ
ードをなす。内容モジュールノードは、実際文書のテキ
ストまたはグラフィックでなった実際内容を表す。内容
モジュールは、階層情報の下に、一つまたはそれ以上が
存在する。そして、本発明では、文書の作成,修正だけ
でなく、プロジェクトの全般的な観点で生命周期と文書
を定義し、文書間の関連性を表現し得る生命周期階層(L
ifecycleLayer) ,文書階層(Document Layer),型板階
層(Template Layer),内容モジュール階層(Content Mod
ule Layer)の4階層文書化モデルを設定することを特徴
とする。In the present invention, by expressing a document in a tree structure, a hierarchical structure of chapters, sections, paragraphs, etc. can be well expressed. The nodes of the tree constituting the document tree are classified into two types, hierarchical information and content modules. The hierarchical information node is a portion corresponding to the table of contents of the document, and is a portion that expresses the structure of the document such as a chapter, a section, and a paragraph of the document. With the document title as the root node, the chapter, section, and paragraph titles form one node each. The content module node represents the actual content of the actual document in text or graphics. One or more content modules exist below the hierarchy information. In the present invention, not only creation and modification of documents, but also life cycles and documents are defined from the overall viewpoint of the project, and the life cycle hierarchy (L
ifecycleLayer), document layer (Document Layer), template layer (Template Layer), content module layer (Content Mod
ule Layer) is set.
【0011】生命周期階層ではプロジェクトに対する管
理情報を定義した後、プロジェクトが遂行される手続き
である生命周期とその産出物である生成文書を定義す
る。文書階層では生命周期階層で定義した文書に関する
細部的な管理情報を入力し、文書作成順序、文書間依存
関係等を定義して次の段階である型板階層で参考とし得
るようにする。型板階層は、文書の構造を定義する段階
で入力される内容の位置と方向を設定する。ツリー形態
の文書構造を定義し、定義した階層情報ノードが他の文
書の階層情報ノードと参照関係を有すべき場合、参照リ
ンクを設定して連結する。In the life cycle hierarchy, management information for a project is defined, and then a life cycle as a procedure for executing the project and a generated document as a product of the life cycle are defined. In the document hierarchy, detailed management information relating to the document defined in the life cycle hierarchy is input, and the document creation order, inter-document dependency, and the like are defined so that they can be referred to in the next stage, the template hierarchy. The template layer sets the position and direction of the contents to be input in the stage of defining the structure of the document. A document structure in the form of a tree is defined, and when the defined hierarchical information node should have a reference relationship with the hierarchical information node of another document, a reference link is set and linked.
【0012】内容モジュール階層では、型板階層で定義
した文書構造に実際的な内容を入力する。即ち、階層的
文書化モデルは文書の構造と全体プロジェクトにおいて
文書の位置を定義する上位3階層と、定義された文書構
造に基づいて実際に文書を作成する下位1階層とからな
る。これら階層は時間上に順次特性を有し、上位階層の
情報が下位階層の情報より高い優先順位を有する。以上
のような階層的文書化モデルは次のような特徴を有す
る。第1に、生命周期と生成文書に対する体系的な管理
が可能である。即ち、文書を生成し管理する単位を生命
周期階層,文書階層,型板階層,内容モジュール階層の
4階層に区分し、階層別にその役割を区別して、プロジ
ェクト,生命周期,文書,文書構造,内容に続く体系的
な文書の作成と管理が可能である。In the content module hierarchy, actual content is input to the document structure defined by the template hierarchy. That is, the hierarchical documentation model is composed of the upper three layers that define the structure of the document and the position of the document in the entire project, and the lower one layer that actually creates the document based on the defined document structure. These layers have characteristics sequentially in time, and the information of the upper layer has higher priority than the information of the lower layer. The above hierarchical documentation model has the following features. First, systematic management of life cycle and generated documents is possible. In other words, the units for generating and managing documents are divided into four layers, namely, life cycle hierarchy, document hierarchy, template hierarchy, and content module hierarchy, and their roles are distinguished by hierarchy, and projects, life cycles, documents, document structures, contents The following systematic creation and management of documents is possible.
【0013】第2に、特定方法論に対して独立的な文書
化が可能である。即ち、瀑布水モデルを基本的な生命周
期モデルとしているが、プロジェクト内の生命周期と生
成文書を定義して使用することにより、瀑布水モデルの
多くの変形方法論を全て収容することができ、よって特
定方法論に依存しない文書化が可能である。第3に、プ
ロジェクトの全体的な観点での文書間の一貫性維持を支
援する。階層的文書化モデルの生命周期階層を除く各階
層別に参照リンクが存在し、上位階層の参照リンクが下
位階層の参照リンクに対するガイドと統制の役割をし、
下位階層参照リンクに対する抽象化された情報を有して
いる。従って、文書作成者は文書作成時に参照リンクを
用いて他の文書の関連部分を易しく正確に捜して参照す
ることができ、プロジェクト内の全文書間に一貫性を維
持する文書化が可能である。Second, independent documentation for a particular methodology is possible. In other words, the waterfall model is a basic life cycle model, but by defining and using the life cycle and generated documents in the project, it is possible to accommodate all of the many transformation methodologies of the waterfall model, Documentation that does not depend on a specific methodology is possible. Third, it helps maintain consistency between documents in the overall perspective of the project. There is a reference link for each hierarchy except the life cycle hierarchy in the hierarchical documentation model, and the reference link in the upper hierarchy acts as a guide and control for the reference link in the lower hierarchy,
It has abstracted information for the lower hierarchy reference link. Therefore, a document creator can easily and accurately search for and refer to a relevant part of another document by using a reference link at the time of document creation, and can maintain documentation between all documents in a project. .
【0014】第4に、文書構造の階層性を反映する。階
層的文書化モデルはツリー資料構造を使用して文書構造
をモデリングした。文書構造をツリー形態として表すこ
とにより、章,節,段落等の階層性をよく表現すること
ができる。本発明では前記のような文書構造及び文書化
モデルを使用して各階層別に参照リンクを設定して文書
の一貫性を維持することを特徴とする。上位階層の参照
リンクは下位階層の参照リンクの生成に対するガイドの
役割をし、下位階層の参照リンクが変わる時、その結果
に対する反映と統制を行う。従って、上位階層の参照リ
ンクは下位階層の参照リンクに対する抽象化された情報
を有し、これを用いて、使用者はプロジェクト全体的な
観点で参照リンクの把握及び管理が行える。また、本発
明により実現される文書化管理支援システムは、参照リ
ンクを用いてHTMLファイルを生成する時に関連文書
を連結するリンクを形成し、よってウェッブラウザを用
いる検索時において、関係ある文書を易しく抽出して検
索することができる。Fourth, the hierarchy of the document structure is reflected. The hierarchical documentation model uses a tree material structure to model the document structure. By expressing the document structure in the form of a tree, it is possible to express well the hierarchy of chapters, sections, paragraphs, and the like. The present invention is characterized in that reference links are set for each layer using the above-described document structure and document model to maintain document consistency. The upper-layer reference link acts as a guide for the generation of the lower-layer reference link, and when the lower-layer reference link changes, reflects and controls the result. Therefore, the reference link of the upper layer has the abstract information of the reference link of the lower layer, and by using this, the user can grasp and manage the reference link from the viewpoint of the entire project. Further, the documentation management support system realized by the present invention forms a link for linking related documents when generating an HTML file using reference links, so that a related document can be easily searched when searching using a web browser. Can be extracted and searched.
【0015】本発明で定義される参照リンクは、生命周
期階層を除く残り3階層に存在する(生命周期間の依存
関係は別に定義しなく生命周期が定義された順序をその
まま使用する。即ち、現在生命周期段階は、以前の全て
の生命周期と依存関係があると仮定する)。即ち、文書
間の依存関係及び文書間作成順序を表す役割をする文書
階層間参照リンクと、型板階層間のリンクを反映してシ
ステムで自動に生成される文書間自動設定参照リンク
と、内容モジュールの作成時に、他の文書の参照すべき
部分を表す型板参照リンクと、内容モジュール階層の参
照リンクに対する要約情報を有するので内容モジュール
階層に参照リンクの変化がある時、その変化を型板階層
に反映するためシステムで自動設定される型板階層自動
設定参照リンクと、実際に参照が行われたないようモジ
ュールと内容モジュールを直接連結する内容モジュール
間参照リンクとから構成される。The reference links defined in the present invention exist in the remaining three layers except the life cycle hierarchy (the dependency between life cycles is not separately defined, and the order in which the life cycles are defined is used as it is. Assume that the current life cycle stage is dependent on all previous life cycles). That is, a reference link between document hierarchies that plays a role of indicating a dependency relationship between documents and a creation order between documents, an automatic document reference link that is automatically generated by the system by reflecting a link between template layers, When a module is created, it has a template reference link indicating the part to be referred to in other documents and summary information for the reference link in the content module hierarchy. A template hierarchy automatic setting reference link automatically set by the system to reflect on the hierarchy, and a content module reference link for directly connecting the module and the content module so that the reference is not actually performed.
【0016】そして、本発明では、階層的文書化モデル
の各階層別に設定されている参照リンクを用いて関連文
書に対する検索を支援し、リンクの設定または消滅時に
その結果が全階層に反映されるように参照リンクを管理
することをその特徴とする。即ち、参照リンクの設定時
に、文書作成者が文書階層,型板階層,内容モジュール
階層で関係を設定する下位階層での関係を把握して、シ
ステムが上位階層のリンクを生成し、かつ内容モジュー
ル間に他の内容モジュールを置き、間接的な参照がある
時に中間モジュールが削除される場合、その情報を型板
階層と文書階層に反映して間接的な参照が行われたこと
を表示する機能を備えることを特徴とする。According to the present invention, a search for a related document is supported by using reference links set for each layer of the hierarchical document model, and when a link is set or deleted, the result is reflected on all layers. The feature is that reference links are managed as described above. That is, when setting the reference link, the document creator grasps the relationship in the lower hierarchy in which the relationship is set in the document hierarchy, the template hierarchy, and the content module hierarchy, and the system generates the upper hierarchy link, and A function to place another content module in between and, when an intermediate module is deleted when there is an indirect reference, reflect that information on the template layer and document layer to indicate that the indirect reference has been made It is characterized by having.
【0017】また、本発明では、プロジェクトを遂行す
る度に文書を一つ一つ定義して使用する不便を補完する
ため、テンプレート(Template)を使用することを特徴と
する。テンプレートは型という意味であり、プロジェク
ト,生命周期,文書関係,文書の内容が包含された構造
を意味し、プロジェクトに対する一種のガイドラインの
役割をする。これにより、文書管理者が文書を定義する
時、文書構造の一貫性を維持することができる。本発明
で支援するテンプレートは、文書一つのみを対象として
独立的にテンプレートに貯蔵する場合には文書間の依存
関係または階層情報間の依存関係情報は表現し得ないか
ら、プロジェクト単位で貯蔵し、ロードして呼び出した
テンプレート内で修正するように支援する。テンプレー
トデータベースは情報貯蔵所構成内容のうち、テンプレ
ートを表現するに必要な情報を貯蔵する別のテーブル
で、情報貯蔵所内のテーブル構造の一部分で構成され
(再使用可能な情報を貯蔵する構造を有する)文書化管
理支援道具のデータベースに貯蔵され、必要なファイル
はテンプレートというディレクトリに貯蔵される。Further, the present invention is characterized in that a template is used in order to supplement the inconvenience of defining and using documents one by one every time a project is performed. A template means a type, a structure that includes a project, life cycle, document relations, and document contents, and serves as a kind of guideline for the project. Thus, when the document manager defines a document, consistency of the document structure can be maintained. If the template supported by the present invention is stored in a template independently for only one document, the dependency information between documents or the dependency information between hierarchical information cannot be expressed. Assist in loading and modifying within the called template. The template database is another table for storing information necessary to represent a template among information repository configuration contents, and is composed of a part of a table structure in the information repository (having a structure for storing reusable information). ) Stored in the database of documentation management support tools, and the necessary files are stored in a directory called templates.
【0018】本発明ではプロジェクトを進行した後、生
命周期と生命周期に属する文書、かつ各文書の構造と内
容モジュールが全てテンプレートの形態で貯蔵し得るよ
うにする。即ち、現在プロジェクトのコードをキー値と
してプロジェクトテーブルからプロジェクトテンプレー
トテーブルに、生命周期テーブルから生命周期テンプレ
ートテーブルに、文書テーブルから文書テンプレートテ
ーブルに現在プロジェクトに関連した全ての情報を複写
して貯蔵する。また、内容モジュールはファイルの形態
として貯蔵されるから、現在プロジェクトに連関した全
ての内容モジュールファイルをテンプレートディレクト
リに複写する。このように複写された情報に使用者が名
前を付与して、他のプロジェクトが進行する時、プロジ
ェクト進行段階または文書の構造等を再使用し得るよう
にすることをその特徴とする。According to the present invention, after the project is advanced, the life cycle and the documents belonging to the life cycle, and the structure and content module of each document can be stored in the form of a template. That is, all information related to the current project is copied and stored from the project table to the project template table, from the life cycle table to the life cycle template table, from the document table to the document template table, using the code of the current project as a key value. In addition, since the content modules are stored in the form of files, all content module files related to the current project are copied to the template directory. It is characterized in that the user gives a name to the copied information so that when another project progresses, the project progress stage or the structure of the document can be reused.
【0019】[0019]
【発明の実施の形態】以下、本発明の一実施の形態を図
面を参照して説明する。図1は本発明のソフトウェア文
書作成装置の構成図であり、図に示すように、ソフトウ
ェア文書作成システムは、入力と検索を担当する使用者
インターフェース1と、文書内容の管理及びメタ情報を
分析して文書生成を処理する文書化管理器2と、出力を
担当する出力生成器3と、情報貯蔵所との連結のための
情報貯蔵所管理器4とから構成されている。前記使用者
インターフェース1は、ウィンドーズに基づいてビジュ
アルベーシックを用いて実現している。入力フィールド
生成器12により自動生成された入力様式が提供され、
オンライン説明が可能であるように説明生成器11を使
用者インターフェースにする。DESCRIPTION OF THE PREFERRED EMBODIMENTS One embodiment of the present invention will be described below with reference to the drawings. FIG. 1 is a block diagram of a software document creation apparatus according to the present invention. As shown in the figure, a software document creation system analyzes a user interface 1 for input and retrieval, management of document contents and meta information. A document management unit 2 for processing document generation, an output generation unit 3 responsible for output, and an information repository management unit 4 for connection to an information repository. The user interface 1 is realized using Visual Basic based on Windows. An input form automatically generated by the input field generator 12 is provided,
The description generator 11 is used as a user interface so that online description is possible.
【0020】前記文書化管理器2は、ソフトウェア文書
作成装置のカーネル(kernel)部分であり、生命周期管理
器21により生命周期の段階設定及び生成される文書の
種類を特定方法論に依存せずに定義することができるよ
うに、閲覧人の等級,参照権限付与等を管理する使用者
管理器24等が文書化管理器2に包含される。一般的な
テキスト情報の作成のための内容モジュール編集器23
があり、グラフィックエディタ等のリンクも担当する。
関係管理器22は、生命周期管理器21と使用者管理器
24との協調により文書間の関係を設定し、また、文書
の個別的な構造を設定し、文書内容間の関係を設定する
こと等により参照リンクを管理する。The documentation manager 2 is a kernel part of the software document creation device. The life cycle manager 21 sets the stage of the life cycle and determines the type of the document without depending on a specific methodology. The document management device 2 includes a user management device 24 that manages the class of the viewer, the grant of reference authority, and the like so that the definition can be defined. Content module editor 23 for creating general text information
There is also a link for graphic editors.
The relationship manager 22 sets the relationship between the documents in cooperation with the life cycle manager 21 and the user manager 24, sets the individual structure of the document, and sets the relationship between the document contents. And the like to manage reference links.
【0021】前記出力生成器3は、文書検索のために、
ウェッブラウザを連結して使用するために、情報貯蔵所
のデータベース内の情報を分析してHTMLファイルに
出力する機能を行う。また、HTMLファイルは、グラ
フィックファイルを別に貯蔵してこれをリンクさせるた
めに、グラフィックファイルを生成するグラフィックフ
ァイル生成器が別に存在する。The output generator 3 is used for searching for a document.
In order to connect and use the web browser, it performs a function of analyzing information in a database of an information storage and outputting it to an HTML file. In addition, the HTML file has a graphic file generator for generating a graphic file in order to store the graphic file separately and to link the graphic file.
【0022】前記情報貯蔵所管理器4は、プロジェク
ト、生命周期、文書に関する情報と関連情報をデータベ
ースに維持するため関係型DBMSを使用して階層的文
書化モデルで取り扱う全ての情報を貯蔵し処理し得る構
造をテーブル形式に構築した。データベース以外に出力
生成器により形成されたHTMLファイルとグラフィッ
クファイルも管理する。The information repository manager 4 stores and processes all information handled in a hierarchical documentation model using a relational DBMS to maintain information on projects, life cycles, documents and related information in a database. A possible structure was constructed in a table format. In addition to the database, it also manages HTML files and graphic files created by the output generator.
【0023】表1及び表2はソフトウェア文書作成装置
の構成フォーム及び機能の説明である(表1と表2は一
体のものである)。ソフトウェア文書作成装置はウィン
ドーズ95の環境下でビジュアルベーシックを使用して
実現している。このビジュアルベーシックでは、ほぼ大
部分の処理がフォームを中心として作成され、実行され
る。従って、システムで要求する各機能は、一つまたは
複数のフォームで構成され、各フォームごとに属性とイ
ベント、プロシージャを定義,作成し、そのフォームを
連結することにより全体的な一つのプログラムとして完
成する。表1及び表2において、初期画面に使用者イン
ターフェースの基盤となるsmdsを始めとしてfpronew, f
proopen, flifecycle, flifede, fdoc, fdocde, fnewtr
ee, fuptree の八つのフォームが生命周期管理器21の
機能を遂行する。参照リンクの管理は、fdoclink, ftre
elink の二つのフォームで遂行する。fdoclinkフォーム
は文書間参照リンクを設定し管理し、ftreelink フォー
ムは階層情報間参照リンクを設定し管理する。Tables 1 and 2 describe the configuration forms and functions of the software document creation device (Tables 1 and 2 are integrated). The software document creator is realized using Visual Basic in the environment of Windows 95. In this Visual Basic, most of the processing is created and executed around a form. Therefore, each function required by the system is composed of one or more forms. Attributes, events, and procedures are defined and created for each form, and the forms are linked to complete a complete program. I do. In Tables 1 and 2, the initial screens include smds, which is the basis of the user interface, and fpronew, f
proopen, flifecycle, flifede, fdoc, fdocde, fnewtr
The eight forms of ee, fuptree perform the functions of life cycle manager 21. Reference links are managed by fdoclink, ftre
Performs in two forms of elink. The fdoclink form sets and manages inter-document reference links, and the ftreelink form sets and manages inter-layer reference links.
【0024】内容モジュール作成器を構成するフォーム
は大きく二通りに区分される。一つはテキストモジュー
ル作成の機能を遂行するfrmwordpadであり、他の一つは
グラフィックモジュール作成の機能を遂行するfrmOLEで
ある。この二つのフォームを連結するのがfrmModuleTyp
e フォームで、使用者の選択によって適当な内容モジュ
ール作成フォームを呼び出す。database.basファイルは
実行時に直接見えるフォームはないが、情報貯蔵所のデ
ータベースを操作し得るプロシージャと変数,常数等を
定義し、filopn.basファイルはファイルの入出力に関す
るプロシージャを包含する。template.basファイルはテ
ンプレートの貯蔵及びロードに関するプロシージャを有
し、html_module.basファイルはHTMLファイル生成
に関するプロシージャを有している。The forms constituting the content module creator are roughly divided into two types. One is frmwordpad, which performs the function of creating a text module, and the other is frmOLE, which performs the function of creating a graphic module. FrmModuleTyp connects these two forms
e In the form, call the appropriate content module creation form according to the user's selection. The database.bas file has no form directly visible at runtime, but defines procedures and variables, constants, etc. that can operate on the information repository database, and the filopn.bas file contains procedures related to file input / output. The template.bas file has procedures for storing and loading templates, and the html_module.bas file has procedures for generating HTML files.
【0025】[0025]
【表1】 [Table 1]
【0026】[0026]
【表2】 [Table 2]
【0027】図2はKS(韓国工業規格)文書化指針に
よって作成された機能要求文書の一部で、一般的な文書
の構造を実際例により表す。図3は図2をシステムで使
用するツリー構造の文書モデルに写像させたものであ
る。文書ツリーを構成するツリーのノードは、階層情報
と内容モジュールの二通りに区分される。図2に実線長
方形で表現されたものが階層情報ノードである。この階
層情報ノードは文書の目次に相当する部分で、文書の
章,節,段落等文書の構造を表現している部分である。
文書題目をルートノードとして1、1.1、1.1.
1、2、2.1のような章,節,段落の題目がそれぞれ
一つのノードをなす。内容モジュールノードは図3に点
線長方形で表示され、実際の文書のテキストまたはグラ
フィックデータの実際的な内容を示す。内容モジュール
は階層情報下に一つまたはそれ以上存在する。FIG. 2 shows a part of a function requirement document prepared according to the KS (Korean Industrial Standard) documentation guideline, and shows the structure of a general document by a practical example. FIG. 3 maps FIG. 2 to a tree-structured document model used in the system. The nodes of the tree constituting the document tree are classified into two types, hierarchical information and content modules. Those represented by solid rectangles in FIG. 2 are hierarchical information nodes. The hierarchical information node is a portion corresponding to the table of contents of the document, and is a portion expressing the structure of the document such as a chapter, a section, and a paragraph of the document.
With the document title as the root node, 1, 1.1, 1.1.
Titles of chapters, sections, and paragraphs such as 1, 2, 2.1 form one node. The content module nodes are represented by dotted rectangles in FIG. 3 and indicate the actual content of the text or graphic data of the actual document. One or more content modules exist under the hierarchy information.
【0028】図4は階層的文書化モデルの全体構造を示
す。階層的文書化モデルにおいて、文書化は4階層に区
分されて進行する。先ず、生命周期階層では、プロジェ
クトに対する管理情報を定義した後、プロジェクトが遂
行される手続きである生命周期とその産出物である生成
文書を定義する。文書階層では、生命周期階層で定義し
た文書に関する細部的な管理情報を入力し、文書作成順
序,文書間依存関係等を定義し、次の段階である型板階
層で参考し得るようにする。型板階層は、文書の構造を
定義する段階で入力内容の位置と方向を設定する。FIG. 4 shows the overall structure of the hierarchical documentation model. In the hierarchical documentation model, documentation proceeds in four layers. First, in the life cycle hierarchy, after defining management information for a project, a life cycle which is a procedure for executing the project and a generated document which is a product of the life cycle are defined. In the document hierarchy, detailed management information related to the document defined in the life cycle hierarchy is input, the document creation order, inter-document dependency, and the like are defined so that the document hierarchy can be referred to in the next stage, the template hierarchy. The template hierarchy sets the position and direction of the input content at the stage of defining the structure of the document.
【0029】ツリー形態の文書構造を定義し、この定義
した階層情報ノードが他の文書の階層情報ノードとの参
照関係を有すべきである場合、参照リンクを設定して連
結する。内容モジュール階層では、型板階層で定義した
文書構造に実際的な内容を入力する。即ち、階層的文書
化モデルは、文書の構造と全体プロジェクトにおいて文
書の位置を定義する上位3階層と定義された文書構造に
基づいて実際に文書を作成する1階層とからなる。この
階層は時間上に順次的特性を有し、上位階層の情報が下
位階層の情報より高い優先順位を有する。A document structure in the form of a tree is defined, and when the defined hierarchical information node should have a reference relationship with the hierarchical information node of another document, a reference link is set and linked. In the content module hierarchy, actual content is input to the document structure defined by the template hierarchy. That is, the hierarchical documentation model is composed of a document structure and three upper layers that define the position of the document in the entire project, and one layer that actually creates the document based on the defined document structure. This layer has a sequential characteristic in time, and information of a higher layer has higher priority than information of a lower layer.
【0030】表3は前記階層的文書化モデルにおいて各
階層別機能と貯蔵管理される情報を示す。生命周期階層
はプロジェクトに対する一般的な定義を行う階層で、プ
ロジェクト定義と生命周期段階定義の二通りの機能を遂
行する。即ち、生命周期階層ではプロジェクトに対する
一般的な事項に対する定義を行った後、プロジェクトが
遂行される手続きである生命周期を定義する。この際
に、生命周期の各段階別に段階名前,責任者,期間等の
一般的な事項と段階別に生成される文書を羅列する。生
命周期階層で設定する情報は、下位の3階層で参照する
値の範囲となる。プロジェクト構成人員を例として挙げ
ると、一旦生命周期階層で入力された人員に対する情報
は下位階層(文書階層,型板階層,内容モジュール階
層)で文書作成者と文書閲覧者設定の母集団となる。即
ち、ここで入力された人々のみがプロジェクト活動に参
与し得る権限があり、万一下位階層で変更事項が生じた
時は、その情報が即時に上位階層に反映される。Table 3 shows the functions for each layer and the information stored and managed in the hierarchical document model. The life cycle hierarchy is a hierarchy that defines general definitions for a project, and performs two functions, project definition and life cycle stage definition. That is, in the life cycle hierarchy, after defining general matters for the project, a life cycle, which is a procedure for performing the project, is defined. At this time, general items such as a stage name, a person in charge, a period, and the like for each stage of the life cycle and documents generated for each stage are listed. The information set in the life cycle hierarchy is a range of values referred to in the lower three hierarchies. As an example of project configuration personnel, information on personnel once input in the life cycle hierarchy is a population of the document creator and the document viewer setting in the lower hierarchy (document hierarchy, template hierarchy, content module hierarchy). That is, only the persons input here have the authority to participate in the project activity, and if a change occurs in the lower hierarchy, that information is immediately reflected in the upper hierarchy.
【0031】文書階層は生命周期階層で定義したソフト
ウェア生命周期別産出文書に対する一般的な定義を行う
階層である。図4に矢印で表現した参照リンクは文書間
依存関係があることを示す。例えば図4において、phas
e1のdoc1とdoc3は、いずれもdoc2に連結されている。こ
れはdoc2の作成時に、doc1とdoc3を参照して作成すべき
であるという依存関係を表示する。また、文書doc2を作
成するためにはdoc1とdoc3が完成されていなければなら
ないので、文書間の作成順序を表示する役割も行う。型
板階層は文書の構造を定義する階層である。The document hierarchy is a hierarchy for performing a general definition for the software life cycle-based output document defined in the life cycle hierarchy. The reference link represented by the arrow in FIG. 4 indicates that there is an inter-document dependency. For example, in FIG.
doc1 and doc3 of e1 are both linked to doc2. This indicates a dependency that doc2 should be created with reference to doc1 and doc3 when it is created. In addition, since doc1 and doc3 must be completed in order to create document doc2, they also serve to display the order of creation between documents. The template hierarchy is a hierarchy that defines the structure of a document.
【0032】文書はツリー形態の構造を有し、構造を定
義した後、定義された階層情報ノードが他の文書の階層
情報ノードとの参照関係を有すべきである場合には、当
該文書の階層情報ノードと参照リンクで連結する。内容
モジュール階層は型板階層で定義した文書構造に文書作
成者が実際的な内容を入力する階層である。文書作成者
は上位3階層で文書管理者が入力した生命周期,文書,
文書構造に関する情報に基づいて作成すべき内容モジュ
ールの位置を選択し、実際内容を入力する。文書化支援
道具は上位階層の参照リンクを用いて関連内容モジュー
ルをブラウジングし、これを参照して文書作成が行われ
るので、関連文書間の一貫性の維持が可能である。A document has a tree-shaped structure. After defining the structure, if the defined hierarchical information node should have a reference relation with the hierarchical information node of another document, Connect with the hierarchy information node by reference link. The content module hierarchy is a hierarchy in which a document creator inputs actual contents into the document structure defined by the template hierarchy. The document creator has entered the life cycle, document,
The position of the content module to be created is selected based on the information on the document structure, and the actual content is input. The documentation support tool browses the related content module using the reference link of the upper hierarchy, and creates a document by referring to the module. Therefore, consistency between related documents can be maintained.
【0033】[0033]
【表3】 [Table 3]
【0034】図5は階層別参照リンクの例を示す。上位
階層の参照リンクは下位階層の参照リンク生成に対する
ガイドの役割を行い、下位階層の参照リンクが変わる
時、その結果に対する反映と統制を行う。従って、上位
階層の参照リンクは下位階層の参照リンクに対する抽象
化された情報を有し、これを用いて使用者はプロジェク
トの全体的な観点から参照リンクを把握、管理し得る。
参照リンクは生命周期階層を除く残りの3階層に存在す
る。生命周期間の依存関係は別に定義しなく生命周期が
定義された順序をそのままで使用する。即ち、現在生命
周期段階は以前の全生命周期と依存関係があると仮定す
る。図5に示す文書階層のリンクは文書間依存関係があ
ることを表示する。即ち、下位階層である型板階層で相
違した階層情報間に依存関係があることを示す。また、
文書の参照は参照される文書が完成された後にだけ可能
なものであるので、文書間作成順序を示す役割もする。
図5において、は、文書Aと文書B間に依存関係があ
り、よって文書Aが完成した後に文書Bが作成されるべ
きであることを表示する。FIG. 5 shows an example of a hierarchical reference link. The upper-layer reference link acts as a guide for the generation of the lower-layer reference link, and reflects and controls the result when the lower-layer reference link changes. Therefore, the reference link of the upper hierarchy has the abstracted information for the reference link of the lower hierarchy, and by using this, the user can grasp and manage the reference link from the overall viewpoint of the project.
Reference links exist in the remaining three layers except the life cycle layer. Dependencies between life cycles are not separately defined, and the order in which the life cycles are defined is used as it is. That is, assume that the current life cycle stage is dependent on the previous entire life cycle. The link of the document hierarchy shown in FIG. 5 indicates that there is inter-document dependency. In other words, this indicates that there is a dependency between different pieces of hierarchical information in the template layer that is the lower layer. Also,
Since a document can be referred to only after the referenced document is completed, it also serves to indicate a document creation order.
FIG. 5 shows that there is a dependency between document A and document B, and therefore document B should be created after document A is completed.
【0035】図5において、階層情報間参照リンク(型
板階層のリンク)は大きく二通りの役割を行う。一つの
役割は、内容モジュールの作成時、他の文書の参照すべ
き部分を示すものである。文書作成者は、内容モジュー
ルを作成する時、文書化支援道具から提供されるブラウ
ジング機能を用いて、参照すべき文書を簡単に捜してみ
ることができる。他の役割は、内容モジュール階層の参
照リンクに対する要約された情報を有するものである。
内容モジュール階層で参照リンクの変化がある時、その
変化を型板階層に反映して、型板階層のリンクも変化す
る。In FIG. 5, the reference link between the hierarchy information (the link of the template hierarchy) plays two major roles. One role is to indicate a part to be referred to in another document when the content module is created. When creating a content module, a document creator can easily search for a document to be referred to by using a browsing function provided by a documentation support tool. Another role is to have summarized information for reference links in the content module hierarchy.
When there is a change in the reference link in the content module hierarchy, the change is reflected in the template hierarchy, and the link in the template hierarchy also changes.
【0036】図5において、型板階層には参照リンクが
三つ存在する。参照リンクととは文書管理者が生成
する階層情報A3とB3、A6とB5とが依存関係があ
ることを示し、内容モジュールの作成時に参照すべき部
分を表示する。参照リンクは内容モジュール階層の参
照リンクの変化を収容するためシステムが自動に生成し
たリンクである。内容モジュールc2を作成する時、b
2を参照して作成し、参照リンクが生成され、これを
型板階層に反映して生成されたものが参照リンクであ
り、参照リンクも同じ理由でシステムが自動に生成し
たリンクである。In FIG. 5, there are three reference links in the template hierarchy. The reference link indicates that the hierarchy information A3 and B3 and the hierarchy information A6 and B5 generated by the document manager have a dependency relationship, and indicates a part to be referred to when the content module is created. The reference link is a link automatically generated by the system to accommodate the change of the reference link in the content module hierarchy. When creating the content module c2, b
2, a reference link is generated, and a reference link is generated by reflecting this in the template hierarchy, and the reference link is also a link automatically generated by the system for the same reason.
【0037】図5において、内容モジュール間参照リン
ク(内容モジュール階層のリンク)は、実際に参照が行
われた内容モジュールと内容モジュールを直接に繋ぐ。
内容モジュールa2とb1間に参照リンクが存在し、こ
れはb1が作成される時にa2を直接参照したことを示
す。従って、b1とa2はその内容が一貫して作成され
る必要があり、a2が変わるとb1も修正される必要が
ある。In FIG. 5, a reference link between content modules (a link in the content module hierarchy) directly connects the content module actually referred to and the content module.
There is a reference link between content modules a2 and b1, which indicates that a2 was directly referenced when b1 was created. Therefore, the contents of b1 and a2 need to be created consistently, and when a2 changes, b1 also needs to be modified.
【0038】図6は参照リンク管理方法で、内容モジュ
ール削除時のリンクの変化を示す。図5のa2→b1ま
たはa3→b2のように、内容モジュール間に直接的な
参照が行われる場合には、モジュールの削除時に、単に
参照リンクのみを除去するとよい。しかし、図5の内容
モジュールa3とc2の場合のように、b2を介して間
接的な参照が行われる場合は、内容モジュールb2が削
除されるとa3とc2は無関係な内容モジュールとな
る。ソフトウェア文書作成装置は、b2が削除された
時、その情報を型板階層と文書階層に反映してa3とc
2間に間接的な参照関係を表示する。即ち、図5におい
て、b2が削除されると、b2に連結された参照リンク
とが削除され、この際にa3とc2を包含している
型板階層のノードであるA6とC6を連結させることに
より、b2が削除されてもa3とc2間には間接的な参
照が行われたことを表示する。そして、文書Aと文書C
間に参照リンクが連結され、参照リンクが除去される
ことにより、参照リンクとも自動に除去される。図
5の内容モジュールb2を除去した結果が図6である。FIG. 6 shows a reference link management method and shows a change in a link when a content module is deleted. When a direct reference is made between the content modules as in a2 → b1 or a3 → b2 in FIG. 5, it is preferable to simply remove the reference link only when deleting the module. However, when the indirect reference is made via b2 as in the case of the content modules a3 and c2 in FIG. 5, when the content module b2 is deleted, a3 and c2 become irrelevant content modules. When b2 is deleted, the software document creation device reflects the information on the template layer and the document layer, and a3 and c
Display an indirect reference relationship between the two. That is, in FIG. 5, when b2 is deleted, the reference link connected to b2 is deleted, and at this time, A6 and C6, which are nodes of the template hierarchy including a3 and c2, are connected. Indicates that an indirect reference has been made between a3 and c2 even if b2 is deleted. And document A and document C
The reference link is connected between them, and the reference link is removed, whereby the reference link is automatically removed. FIG. 6 shows the result of removing the content module b2 of FIG.
【0039】表4,表5は文書テンプレートのスキーマ
構造を示す(表4と表5一体のものである)。プロジェ
クトを遂行する度に文書を一つ一つ定義して使用する不
便を補完するためにテンプレートを使用するが、本発明
で支援するテンプレートは、文書一つのみを対象として
独立的にテンプレートに貯蔵する場合には文書間依存関
係または階層情報間依存関係情報は表現し得ないため、
プロジェクト単位で貯蔵し、この貯蔵場所からロードし
呼出したテンプレート内で修正するように支援する。テ
ンプレートデータベースは情報貯蔵所構成内容のうちテ
ンプレートを表現するに必要な情報を貯蔵する別のテー
ブルで、情報貯蔵所内のテーブル構造の一部分で構成さ
れて(再使用し得る情報を貯蔵する構造を有する)文書
化管理支援道具のデータベースに貯蔵され、必要なファ
イルはtemplateというディレクトリに貯蔵される。Tables 4 and 5 show the schema structure of the document template (combined with Tables 4 and 5). Templates are used to compensate for the inconvenience of defining and using documents one by one every time a project is performed. However, the templates supported by the present invention are stored in templates independently for only one document. In this case, inter-document dependency or inter-hierarchical information cannot be expressed.
Store on a project-by-project basis and assist in loading and modifying from within the loaded template from this repository. The template database is another table for storing information necessary for expressing a template in the contents of the information repository, and is composed of a part of a table structure in the information repository (having a structure for storing reusable information). ) Document management support tools are stored in the database, and the necessary files are stored in a directory called template.
【0040】本発明では、プロジェクトを進行した後に
は、生命周期と生命周期に属する文書、かつ各文書の構
造と内容モジュールが全てテンプレートの形態で貯蔵し
得るようにする。即ち、現在プロジェクトのコードをキ
ー値としてプロジェクトテーブルからプロジェクトテン
プレートテーブルに、生命周期テーブルから生命周期テ
ンプレートテーブルに、文書テーブルから文書テンプレ
ートテーブルに、現在プロジェクトに関連した全ての情
報を複写して貯蔵する。また、内容モジュールはファイ
ルの形態で貯蔵されるため、現在のプロジェクトに連関
した全ての内容モジュールファイルをtemplateディレク
トリに複写する。このように複写された情報に使用者が
名前を付与して他のプロジェクトを進行する時、プロジ
ェクト進行段階または文書の構造等を再使用でき、異な
るプロジェクトまたは文書間において一貫した構造を有
し得る。According to the present invention, after the project is advanced, the life cycle and the documents belonging to the life cycle, and the structure and content module of each document can be stored in the form of a template. That is, all information related to the current project is copied and stored from the project table to the project template table, from the life cycle table to the life cycle template table, from the document table to the document template table, using the code of the current project as a key value. . Also, since the content modules are stored in the form of files, all content module files associated with the current project are copied to the template directory. When the user assigns a name to the copied information and proceeds with another project, the project progress stage or the structure of the document can be reused, and a consistent structure can be obtained between different projects or documents. .
【0041】[0041]
【表4】 [Table 4]
【0042】[0042]
【表5】 [Table 5]
【0043】図7は本発明のソフトウェア文書作成シス
テムにおける文書作成及び検索の流れを示す。ソフトウ
ェア文書作成システムの使用者は、文書管理者(super-u
ser)と一般使用者(general user)とに区分される。文書
管理者は、プロジェクトが進行する全般的な内容(生命
周期,文書,文書構造)に対する定義を行い(S1xx
段階)、一般使用者は文書管理者が定義した文書構造に
従って文書を作成し、作成された文書を検索,出力する
(S2xx段階)。文書を定義するためには当該文書が
プロジェクト内のどこに位置するかに対する定義を先ず
行われなければならない。即ち、文書管理者に対する使
用者確認(S101)後にプロジェクトに対する定義を
遂行し(S103)、次いで生命周期に対する定義を遂
行する(S105)。この際に、新たなプロジェクトを
遂行する場合には使用者の情報を入力し(S102)、
既存のプロジェクトを呼び出した場合にはプロジェクト
情報を確認するようにする(S104)。文書を定義し
た(S107〜S109)後には文書構造を定義する
(S110,S111)。FIG. 7 shows the flow of document creation and retrieval in the software document creation system of the present invention. The user of the software documentation system is the document administrator (super-u
ser) and general users. The document manager defines a general content (life cycle, document, document structure) in which the project proceeds (S1xx).
Step), the general user creates a document according to the document structure defined by the document manager, searches and outputs the created document (S2xx step). In order to define a document, a definition of where the document is located in the project must first be made. That is, after confirming the user with the document manager (S101), the definition for the project is performed (S103), and then the definition for the life cycle is performed (S105). At this time, when performing a new project, user information is input (S102).
When an existing project is called, the project information is confirmed (S104). After defining the document (S107 to S109), the document structure is defined (S110, S111).
【0044】プロジェクト定義から文書構造定義までを
文書定義といい、文書管理者がこれを遂行する。文書を
定義する段階は各生命周期段階別に必要な文書を定義し
(S107)、文書間の関係を設定し(S108)、各
生命周期段階別文書を再び確認する(S109)。文書
を定義する段階は各文書の構造を章,節,段落別に区分
してツリー構造に定義し(S110)、各下部構造間の
関係をリンクで設定する(S111)。文書作成者(一
般使用者)は使用者確認(S201)後、定義された文
書構造上で内容モジュールを作成する(S202)。文
書構造定義画面で“内容モジュール新規作成ボタン”を
押すと編集器が画面に現れ、編集器を用いて文書の内容
を作成する。完成された内容は自動にデータベースに貯
蔵され、システムはこれを分析してHTMLファイルに
作成する(S206)。この際にテキスト形態の内容で
ある場合には、SDMSから提供するテキストエディタ
を使用し、グラフィック形態の内容はOLE機能を用い
てグラフィックエディタをリンクして使用する。The process from the project definition to the document structure definition is called a document definition, and is performed by a document manager. In the step of defining a document, necessary documents are defined for each life cycle stage (S107), a relationship between the documents is set (S108), and the document for each life cycle stage is confirmed again (S109). In the step of defining a document, the structure of each document is divided into chapters, sections, and paragraphs to define a tree structure (S110), and a relationship between each substructure is set by a link (S111). After confirming the user (S201), the document creator (general user) creates a content module on the defined document structure (S202). When a "content module new creation button" is pressed on the document structure definition screen, an editor appears on the screen, and the contents of the document are created using the editor. The completed contents are automatically stored in a database, and the system analyzes the generated contents and creates an HTML file (S206). At this time, if the contents are in the form of text, a text editor provided by SDMS is used, and the contents of the graphic form are used by linking the graphic editor using the OLE function.
【0045】文書作成時、関連文書との一貫性維持のた
め関連文書を参照することもできる(S203)。シス
テムがHTMLファイルを生成する時、特別な形態を望
むと文書の様式を別に定義することもできる(S20
5)。文書の検索のためメニュー窓で検索を選択すると
(S204)、文書閲覧(S207)またはキーワード
検索(S208)が可能である。文書閲覧時には全体閲
覧(S209)または部分閲覧(S210)が可能であ
る。そして、キーワード検索では、当該文書を捜そうと
する文書キーワード検索(211)または当該内容モジ
ュールを捜そうとする内容モジュールキーワード検索
(S212)が可能である。At the time of document creation, a related document can be referred to in order to maintain consistency with the related document (S203). When the system generates the HTML file, if a special form is desired, the format of the document can be separately defined (S20).
5). When a search is selected in the menu window to search for a document (S204), document browsing (S207) or keyword search (S208) is possible. At the time of document browsing, whole browsing (S209) or partial browsing (S210) is possible. In the keyword search, a document keyword search for searching the document (211) or a content module keyword search for searching the content module can be performed (S212).
【0046】[0046]
【発明の効果】以上説明のように本発明によれば、ソフ
トウェアの開発において、開発方法及び手続きに独立的
であり、一貫性維持が可能である階層構造及び関係を設
定しつつソフトウェアを開発する全産業体(システム統
合業者,ソフトウェアハウス,In-house開発者)がソフ
トウェア開発過程で生成される産出物である各種文書を
易しく作成することができ、これを一貫性をもたせて維
持し管理することができるソフトウェア文書作成システ
ム及びその運用方法とすることができる。As described above, according to the present invention, in software development, software is developed while setting a hierarchical structure and relationships that are independent of development methods and procedures and can maintain consistency. All industrial entities (system integrators, software houses, in-house developers) can easily create various documents that are products generated during the software development process, and maintain and manage them with consistency And a method of operating the same.
【図1】本発明を実現するソフトウェア文書作成システ
ムの構成図である。FIG. 1 is a configuration diagram of a software document creation system that implements the present invention.
【図2】本発明のソフトウェア文書の例示図である。FIG. 2 is an exemplary diagram of a software document of the present invention.
【図3】本発明の文書構造図である。FIG. 3 is a document structure diagram of the present invention.
【図4】本発明の階層的文書化モデルの構造図である。FIG. 4 is a structural diagram of a hierarchical documentation model of the present invention.
【図5】本発明の階層別参照リンク設定概念図である。FIG. 5 is a conceptual diagram of setting a reference link for each layer according to the present invention.
【図6】内容モジュール削除時の参照リンクの変化図で
ある。FIG. 6 is a change diagram of a reference link when a content module is deleted.
【図7】本発明の処理流れ図である。FIG. 7 is a processing flowchart of the present invention.
1 使用者インターフェース 2 文書化管理器 3 出力生成器 4 情報貯蔵所 11 説明生成器 12 入力フィールド生成器 21 生命周期管理器 22 関係管理器 23 内容モジュール編集器 24 使用者管理器 DESCRIPTION OF SYMBOLS 1 User interface 2 Documentation manager 3 Output generator 4 Information repository 11 Explanation generator 12 Input field generator 21 Life cycle manager 22 Relationship manager 23 Content module editor 24 User manager
───────────────────────────────────────────────────── フロントページの続き (72)発明者 ベク ドゥ クォン 大韓民国 ソウル市 江東區 ドゥンチョ ン洞 現代アパート 102−402 (72)発明者 ナ ホン ソク 大韓民国 ソウル市 ソンパ區 プンナプ 洞 88−20 (72)発明者 ザン ソン ボン 大韓民国 京畿道 グンポ市 ダン洞 766−22 ──────────────────────────────────────────────────続 き Continuing on the front page (72) Inventor Bek Du Kwon Modern apartment 102-402 (72) Incheon, Gangnam-gu, Seoul South Korea Inventor Na Hong Suk 88-20 (72) Invention, Punnap-dong, Songpa-gu, Seoul Zhan Song Bong 766-22 Dan-dong, Gumpo, Gyeonggi-do, Republic of Korea
Claims (8)
ェース(1)と、文書内容の管理及びメタ情報を分析し
て文書生成を処理する文書化管理器(2)と、文書出力
を担当する出力生成器(3)と、プロジェクト,生命周
期,文書に関する情報と関連情報をデータベースに維持
する情報貯蔵所管理器(4)とから構成されることを特
徴とするソフトウェア文書の階層構造及び関係を用いる
ソフトウェア文書作成システム。1. A user interface (1) for inputting and retrieving, a document manager (2) for managing document contents and analyzing meta information to process document generation, and an output for document output. Using a hierarchical structure and relationships of software documents characterized by comprising a generator (3) and an information repository manager (4) for maintaining information on projects, life cycles, documents and related information in a database. Software documentation system.
ンライン説明が可能であるように、説明生成器(11)
と、自動生成された入力様式を提供する入力フィールド
生成器(12)とからなることを特徴とする請求項1記
載のソフトウェア文書の階層構造及び関係を用いるソフ
トウェア文書作成システム。2. An explanation generator (11), wherein said user interface (1) is capable of providing online explanation.
2. The software document creation system according to claim 1, further comprising an input field generator for providing an automatically generated input format.
段階設定及び生成される文書の種類を特定方法論に依存
せず定義し得るようにする生命周期管理器(21)と、
文書の一貫性維持を担当する関係管理器(22)と、一
般的なテキスト情報の作成を可能にし、グラフィックエ
ディタ等のリンクも担当する内容モジュール編集器(2
3)と、閲覧人の等級、参照権限付与等を管理する使用
者管理器(24)とからなることを特徴とする請求項1
記載のソフトウェア文書の階層構造及び関係を用いるソ
フトウェア文書作成システム。3. The life cycle manager (21), which is capable of defining the stage setting of the life cycle and the type of the generated document without depending on a specific methodology.
A relationship manager (22) responsible for maintaining document consistency and a content module editor (2) that enables creation of general text information and also links such as graphic editors
3) and a user management device (24) for managing the class of the viewer, the grant of reference authority, and the like.
A software document creation system using a hierarchical structure and relationships of the described software documents.
ジュール編集器(23)及び関係管理器(22)に適用
し、文書を貯蔵し処理する単位となる文書をツリー構造
に定義し、文書ツリーを構成するツリーのノードを文書
の目次に相当する部分で、文書の章,節,段落等文書の
構造を表現する階層情報と、実際文書のテキストまたは
グラフィックでなった実際内容を示す内容モジュールと
の二通りに区分されたツリー構造の文書モデルに定義す
ることを特徴とする請求項2または3記載のソフトウェ
ア文書の階層構造及び関係を用いるソフトウェア文書作
成システム。4. A document which is applied to an input field generator (12), a content module editor (23), and a relation manager (22) to define a document as a unit for storing and processing the document in a tree structure, A node corresponding to the table of contents of a tree, the hierarchical information representing the structure of the document, such as chapters, sections, and paragraphs of the document, and a content module indicating the actual contents of the actual document in text or graphics. 4. The software document creation system according to claim 2, wherein the document model is defined in a document model having a tree structure divided into two types.
(22)に適用し、文書の作成、修正だけでなくプロジ
ェクト全般的な観点で生命周期と文書を定義し文書間の
関連性を表現し得る生命周期階層,文書階層,型板階
層,内容モジュール階層の4階層の文書化モデルを設定
することを特徴とする請求項3記載のソフトウェア文書
の階層構造及び関係を用いるソフトウェア文書の階層構
造及び関係を用いるソフトウェア文書作成システム。5. The invention is applied to the life cycle manager (21) and the relation manager (22), and defines a life cycle and a document from the viewpoint of not only creation and modification of the document but also a project as a whole, and determines the relationship between the documents. 4. A software document hierarchy using a software document hierarchy and relationships as set forth in claim 3, wherein a four-layered documentation model that can be expressed is a life cycle hierarchy, a document hierarchy, a template hierarchy, and a content module hierarchy. A software documentation system that uses structures and relationships.
各階層別に参照リンクを設定し、この参照リンクの設定
時に、文書作成者が文書階層,型板階層,内容モジュー
ル階層で関係を設定する下位階層での関係を把握してシ
ステムが上位階層のリンクを生成し、内容モジュール間
に他の内容モジュールを置いて間接的な参照がある際に
おいて中間モジュールが削除される場合、その情報を型
板階層と文書階層に反映して間接的な参照が行われたこ
とを表示する機能を備えることを特徴とする請求項4ま
たは5記載のソフトウェア文書の階層構造及び関係を用
いるソフトウェア文書作成システム。6. A reference link is set for each hierarchy using the document structure and the documentation model, and at the time of setting the reference link, a document creator sets a relationship between a document hierarchy, a template hierarchy, and a content module hierarchy. When the system creates a link in the upper hierarchy by grasping the relationship in the lower hierarchy to be created and the intermediate module is deleted when there is an indirect reference by placing another content module between the content modules, the information is deleted. 6. The software document creation system according to claim 4, further comprising a function of displaying that the indirect reference has been performed by reflecting the indirect reference to the template layer and the document layer. .
ロジェクトを遂行する度に文書を一つ一つ定義して使用
する不便を補完するために、テンプレートを貯蔵,呼び
出し,複写が行えるように支援することを特徴とするソ
フトウェア文書の階層構造及び関係を用いるソフトウェ
ア文書作成システム。7. A software document creation device that supports storing, recalling, and copying of templates to complement the inconvenience of defining and using documents one by one each time a project is performed. A software document creation system that uses a hierarchical structure and relations of software documents as features.
運用方法において、文書管理者が、プロジェクトが進行
する全般的な内容(生命周期、文書、文書構造)に対す
る定義を行う段階(S101〜S111)と、一般使用
者が、文書管理者が定義した文書構造によって文書を作
成し、作成された文書を検索し、出力する段階(S20
1〜S212)とから構成されることを特徴とするソフ
トウェア文書の階層構造及び関係を用いるソフトウェア
文書作成システムの運用方法。8. An operation method applied to a software document creation device, wherein a document manager defines a general content (life cycle, document, document structure) in which a project proceeds (S101 to S111). The general user creates a document according to the document structure defined by the document administrator, searches for the created document, and outputs the document (S20).
1 to S212), a method for operating a software document creation system using a hierarchical structure and relationships of software documents.
Applications Claiming Priority (2)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| KR1997P67909 | 1997-12-11 | ||
| KR1019970067909A KR980004026A (en) | 1997-12-11 | 1997-12-11 | Software document creation system and its operation method using hierarchy and relationship of software document |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| JPH11184687A true JPH11184687A (en) | 1999-07-09 |
Family
ID=19527080
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| JP10035498A Pending JPH11184687A (en) | 1997-12-11 | 1998-02-02 | Software document creation system using hierarchical structure and relation of software document and its operation method |
Country Status (2)
| Country | Link |
|---|---|
| JP (1) | JPH11184687A (en) |
| KR (1) | KR980004026A (en) |
Cited By (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| JP2004280488A (en) * | 2003-03-17 | 2004-10-07 | Hitachi Ltd | Document management method and document management device |
| JP2008059428A (en) * | 2006-09-01 | 2008-03-13 | Mitsubishi Electric Corp | Document data management apparatus, document data management method, and program |
| CN102495832A (en) * | 2011-12-12 | 2012-06-13 | 方正国际软件有限公司 | System for automatically generating document in software development process |
| JP2023554030A (en) * | 2020-12-15 | 2023-12-26 | 北京字跳▲網▼絡技▲術▼有限公司 | Document processing methods, devices and electronic equipment |
| WO2024185852A1 (en) * | 2023-03-07 | 2024-09-12 | アセンブローグ株式会社 | Information processing device, information processing method, and program |
Families Citing this family (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| KR20000019231A (en) * | 1998-09-09 | 2000-04-06 | 구자홍 | Automatic high level query system using level image characteristic structure and low level |
| KR100400360B1 (en) * | 2000-09-06 | 2003-10-04 | 삼성에스디에스 주식회사 | System for automatic generating program products and method thereof |
| US20110314361A1 (en) * | 2010-06-21 | 2011-12-22 | Microsoft Corporation | Generating recommendations for improving a presentation document |
| KR102913306B1 (en) | 2024-12-10 | 2026-01-15 | (주)블루비즈랩 | V-Model linkage system |
-
1997
- 1997-12-11 KR KR1019970067909A patent/KR980004026A/en not_active Ceased
-
1998
- 1998-02-02 JP JP10035498A patent/JPH11184687A/en active Pending
Cited By (6)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| JP2004280488A (en) * | 2003-03-17 | 2004-10-07 | Hitachi Ltd | Document management method and document management device |
| JP2008059428A (en) * | 2006-09-01 | 2008-03-13 | Mitsubishi Electric Corp | Document data management apparatus, document data management method, and program |
| CN102495832A (en) * | 2011-12-12 | 2012-06-13 | 方正国际软件有限公司 | System for automatically generating document in software development process |
| JP2023554030A (en) * | 2020-12-15 | 2023-12-26 | 北京字跳▲網▼絡技▲術▼有限公司 | Document processing methods, devices and electronic equipment |
| US12216718B2 (en) | 2020-12-15 | 2025-02-04 | Beijing Zitiao Network Technology Co., Ltd. | Document processing method and apparatus, and electronic device |
| WO2024185852A1 (en) * | 2023-03-07 | 2024-09-12 | アセンブローグ株式会社 | Information processing device, information processing method, and program |
Also Published As
| Publication number | Publication date |
|---|---|
| KR980004026A (en) | 1998-03-30 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| Campbell et al. | HAM: A general-purpose hypertext abstract machine | |
| Estublier et al. | Impact of software engineering research on the practice of software configuration management | |
| US7783678B2 (en) | Method for automating software manufacturing process based on user interface form design, and computer readable medium recording computer executable instruction for performing the same | |
| US6571247B1 (en) | Object oriented technology analysis and design supporting method | |
| US6327593B1 (en) | Automated system and method for capturing and managing user knowledge within a search system | |
| US7822795B2 (en) | Apparatus and methods for displaying and determining dependency relationships among subsystems in a computer software system | |
| AU2013205927B2 (en) | Methodology infrastructure and delivery vehicle | |
| CN1818901B (en) | Method and computer system for interacting with a database | |
| US8830266B1 (en) | Merging electronic diagrams | |
| Jayapandian et al. | Expressive query specification through form customization | |
| EP0560938A1 (en) | Method and apparatus for engineering for a data model | |
| JP2008512794A (en) | Object processing graph application development system | |
| JP2014225284A (en) | Process control system and method | |
| McManus | Database Access with Visual Basic 6 | |
| JP2006172446A (en) | Complex data access | |
| Woodbury et al. | Erasure in design space exploration | |
| Gomaa et al. | Domain modeling for software reuse and evolution | |
| JPH0743700B2 (en) | Data-driven information processing device | |
| Schwabe et al. | Hypertext development using a model‐based approach | |
| EP1367503A1 (en) | Method for displaying and modifying a relational database schema | |
| Auddino et al. | SUPER—Visual interaction with an object-based ER model | |
| KR20000063360A (en) | A method of design information management in CAD sistem | |
| JP3516843B2 (en) | Database access method | |
| Bingley et al. | A design platform for the NELSIS CAD framework | |
| JPH06501576A (en) | dynamic information management computer system |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| A02 | Decision of refusal |
Free format text: JAPANESE INTERMEDIATE CODE: A02 Effective date: 19990803 |