4.2.2 ドキュメントを作成する
プログラムの開発で作成する設計文書を各々の作業環境で作成すると,書式の不統一や記述漏れが発生します。また,ほかの開発者が設計文書を参照しようとしても,保管場所を容易に探せません。このようなことを防ぎ,効率良くシステムを開発するために,SEWB+/REPOSITORYを使って次のように運用します。
- テンプレート機能を利用してドキュメントを作成する。
- 各ドキュメントをフォルダで一括管理し,システムバージョンを設定してバージョンを管理する。
設計文書のフォルダは,ルートドキュメントフォルダの下に「基本仕様書」「機能仕様書」及び「詳細設計書」の名称で作成してあります。各文書は,SEWB+/REPOSITORYの環境構築ユティリィでドキュメント種別やテンプレートファイルパスが登録されています。
ドキュメント作成の手順を次に示します。
- テンプレートファイルのパス先に,Microsoft Wordなどで作成したテンプレートを用意する
このテンプレートは,リポジトリブラウザの[リポジトリ]メニューの[新規作成]から[ドキュメント]を選択したとき,自動的に呼び出されます。
- サーバでSEWB+/REPOSITORYが起動していることを確認する
- クライアントでリポジトリブラウザを起動する
- リポジトリブラウザのウィンドウ上で,作成する設計文書のドキュメントフォルダを選ぶ
- [リポジトリ]メニューの[新規作成]から[ドキュメント]を選ぶ
[ドキュメントの作成]ダイアログが表示されます。
- [ドキュメントの作成]ダイアログに,次の設定をする
項 目 | 設定内容 |
---|
ドキュメント種別 | リストからドキュメント種別を選択する。 現在作成しようとするドキュメントが先に定義したドキュメント種別のどれに該当するかを指定する。 |
ドキュメント名 | ドキュメント名を入力する。 |
システムバージョンの設定 | 「System V1.0」を選択する。 これで先に定義したシステムバージョンと関連付ける。 |
コメント | 作成や変更の履歴を記述する。 |
チェックアウト先フォルダ | チェックアウト先フォルダを選択する。 |
- [OK]ボタンを選ぶ
ユーザの作業環境に,チェックアウトされた状態で設計文書(テンプレート)が開きます。
- 仕様書を作成する
- リポジトリブラウザのウィンドウでドキュメントを選び,[リポジトリ]メニューから[チェックイン]を選ぶ
[チェックイン]ダイアログが表示されます。
- 「チェックアウトファイルの操作」に「チェックアウトファイルを削除する」を指定して[OK]ボタンを選ぶ
チェックインが実行されて[チェックイン]ダイアログが閉じます。