2.1.2 ドキュメントの管理

リポジトリで管理するドキュメントについて説明します。

システム開発で扱うファイルは,リポジトリ上ではドキュメントという名称の資源として管理されます。ファイルに種類があるように,ドキュメントにも種類があります。ドキュメントの種類のことをドキュメント種別といいます。

<この項の構成>
(1) ドキュメント種別
(2) ドキュメントの更新履歴
(3) システムバージョンによるドキュメントの管理

(1) ドキュメント種別

リポジトリで扱うドキュメント種別は,システム管理者が環境構築ユティリティを使用して登録します。

なお,SEWB+ツール(SEWB+/CONSTRUCTIONなど)で扱うドキュメント種別は,そのツールから自動的に登録されます。また,環境情報のインポート(配布)によって,ドキュメント種別を登録することもできます。

(a) ドキュメント種別が持つ情報

ドキュメントは,メインファイル,サブファイル,テンプレートファイルなどの属性を持っています。これらの属性を,ドキュメント種別として登録できます。ドキュメント種別を登録しておくと,効率良くドキュメントを作成できます。

(b) メインファイルサブファイル

アプリケーションの中には,アプリケーションが扱うデータを複数のファイルで管理するものがあります。そのため,リポジトリでは,複数のファイルを一つのドキュメントとして管理できるようになっています。この一つのドキュメントとして管理する,ファイルをメインファイルといいます。また,メインファイルに従属するファイルをサブファイルといいます。

SEWB+/REPOSITORYでは,メインファイルとサブファイルをドキュメント種別に登録できます。サブファイルの登録は任意です。

サブファイルを登録すると,リポジトリからドキュメントを出し入れする場合に,メインファイルを指定するだけで同時にサブファイルもリポジトリから出し入れできます。

(c) テンプレートファイル

テンプレートファイルとは,編集するドキュメントのひな型として利用するファイルです。テンプレートファイルはドキュメント種別に登録できます。ドキュメントのメインファイルおよびサブファイルに,それぞれテンプレートファイルを登録できます。

テンプレートとして登録したファイルは,リポジトリにコピーされます。このテンプレートはドキュメントの新規作成時に呼び出されます。テンプレートが登録されていないドキュメント種別のドキュメントは,新規作成できません。

(2) ドキュメントの更新履歴

それぞれのドキュメントは,リポジトリ内に更新履歴を持ちます。更新履歴情報の持ち方は,更新ごとにドキュメントを持ちます。

(3) システムバージョンによるドキュメントの管理

(a) システムバージョンとは

システム開発のプロジェクトでは,設計文書やプログラムなどの複数のドキュメントを作成します。システム開発工程のある時点では,ドキュメントによって更新の回数(版の数)が異なります。このため,システム開発に関係する複数のドキュメントに対して,最新の版がわかるように管理することが重要です。

SEWB+/REPOSITORYでは,個々のドキュメントの版に対して,特定のバージョン名を設定できます。この特定のバージョン名をシステムバージョンといいます。

システムバージョンは,固定浮動の区別を付けたり,システムバージョンを階層化したりできます。固定のシステムバージョンは,常に設定した時点の版を示します。浮動のシステムバージョンは設定した時点以降に更新された最新の版を示します。システムバージョンの階層化については,「2.1.2(3)(c) システムバージョンの階層化」を参照してください。

(b) システムバージョンの固定と浮動

システムバージョンの固定と浮動の設定例を次の図に示します。

図2-1 システムバージョンの設定例

[図データ]

システムバージョンは,設定したあとでも,任意の時点で固定と浮動とを切り替えることができます。システムバージョンの切り替え例を次の図に示します。

図2-2 システムバージョンの切り替え例

[図データ]

(c) システムバージョンの階層化

システムバージョン自身も,親のシステムバージョンに属することができるため,ツリー構造で更新履歴を管理できます。階層化されたシステムバージョンの例を次の図に示します。

図2-3 階層化されたシステムバージョン例

[図データ]

(d) システムバージョンの作成と設定

システムバージョンは,すべてのユーザが作成できます。ドキュメントに対してシステムバージョンを設定または解除するには,そのドキュメントに対する読み取り権と,システムバージョンの設定権が必要です。システムバージョンの作成または削除と,ドキュメントに対しての設定または解除は,リポジトリブラウザで操作します。

(e) システムバージョンの使用例

システムバージョンの使用例を次に示します。

(例1)
新規システムの開発時に,新規システム名の浮動システムバージョンを作成して,作成や登録するドキュメントに設定します。
(例2)
システムの開発終了時に,浮動システムバージョンを固定システムバージョンに切り替えます。
(例3)
既存システムをバージョンアップするときに,既存のシステムバージョンを複製して,バージョンアップを示す名称の浮動システムバージョンを作成します。新規に作成や登録するドキュメントには,新しいシステムバージョンを設定します。
(例4)
システムの開発中に,ほかの開発グループへドキュメントを配布することがあります。ドキュメントの配布には,エクスポート・インポート機能を使用します。このとき,現システムバージョンを指定してエクスポートすれば該当するドキュメントを絞り込めます。エクスポート時の内容を保存したければ,現システムバージョンを複製し,エクスポートの内容がわかる名称の固定システムバージョンを作成します。
(例5)
ある特定のドキュメントをほかの開発グループへ配布する場合に,任意の名称のシステムバージョンを作成します。そのシステムバージョンを該当するドキュメントに設定します。ドキュメントの配布には,エクスポート・インポート機能を使用します。エクスポートする際,そのシステムバージョンを指定し,エクスポート対象のドキュメントを絞り込みます。
(f) システムバージョンの留意事項

一つのドキュメントを別々の目的(バージョン)で更新するような運用はできません。例えば,旧システムバージョンのドキュメントを更新するような場合は,エクスポート・インポート機能を使用して,旧システムバージョンが設定されているドキュメントをエクスポートします。そして,マスタとは別のルートドキュメントフォルダ,または別のリポジトリへインポートしてから更新します。この場合,修正内容のマスタへの反映は,ユーザが手作業で実行する必要があります。