レビュー (CMMI)
このトピックでは、レビュー作業項目の詳細を入力する方法について学習できます。 チームは、レビュー作業項目を使用してデザイン レビューまたはコード レビューの結果を文書化できます。 チーム メンバーは、名前の正確性、コードの関連性、拡張性、コードの複雑性、アルゴリズムの複雑性、およびコードの安全性の領域において、デザインまたはコードがどのように標準を満たしているかを詳細に確認できます。 詳細については、「開発タスクの実装」を参照してください。
このタイプの作業項目を作成する方法については、「作業項目とワークフロー (CMMI)」を参照してください。
このトピックの内容 |
関連トピック |
---|---|
|
プロセス ガイダンス フィールド参照 |
必要なアクセス許可
レビューを表示するには、読み取りユーザー グループのメンバーであるか、または [このノードの作業項目を表示します] が [許可] に設定されている必要があります。 レビューを変更するには、貢献者グループのメンバーであるか、または [このノードの作業項目を編集します] のアクセス許可が [許可] に設定されている必要があります。 詳細については、「アクセス許可の管理」を参照してください。
レビューの定義
レビューの作業項目フォームは、次の図に示すフィールドとタブにデータを保存します。
レビューを定義する場合は、作業項目フォームの最上部のセクションにタイトルを定義し、[詳細] タブで目的を入力する必要があります。 他のフィールドは、空白または既定値のままでかまいません。
単一のレビューを定義するには
作業項目フォームの最上部のセクションで、次のような情報を 1 つ以上指定します。
[タイトル] (必須) に、レビューと他のレビュー作業項目を区別する簡単な説明を入力します。
適切なタイトルを付けることで、レビュー済みのコード セクションまたはデザイン領域が識別されます。
[会議の種類] ボックスで、レビューに使用された会議の種類をクリックします。
有効な値は、[会議] または [オフライン] です。
[担当者] ボックスで、レビューを担当するチーム メンバーの名前をクリックします。
注意
作業項目は、貢献者グループのメンバーにのみ割り当てることができます。
レビューの担当者を割り当てない場合、レビューを定義するユーザーが自動的に担当者になります。
[状態] ボックスでは、既定値であるアクティブをそのまま使用します。
[主催者] セクションで、会議を呼びかけたチーム メンバーの名前をクリックし、会議の日付を入力します。
[詳細] タブで、レビューに適用された基準に加え、レビュー済みのコード領域またはデザイン領域についてできる限り詳細に説明します。
[会議メモ] タブで、レビュー会議で得られた結果、ディスカッション、基準、および決定についてできる限り詳細に説明します。
この情報には、レビュー内容、適用された基準、特定された問題などが含まれます。
[コメント] タブで、他の場所で十分に説明されていないレビューに関するその他の情報を入力します。
[出席者] タブで、レビューの必須出席者、任意出席者、または実際の出席者である各チーム メンバーの名前をクリックします。
これらのチーム メンバーは、レビュー委員会のメンバーです。
[すべてのリンク] タブで、レビューを要件やタスクなどの 1 つ以上の他の作業項目にリンクします。
[添付ファイル] タブで、仕様、イメージ、または保持するレビューに関する詳細を提供するその他のファイルを添付します。
詳細については、このトピックの次のセクションを参照してください。
要件、タスク、またはその他の作業項目へのレビューのリンク
レビューへの詳細、添付ファイル、またはハイパーリンクの追加
[作業項目の保存] をクリックします。
注意
レビューを保存すると、作業項目ツール バーの下のタイトルに識別子が表示されます。
要件、タスク、またはその他の作業項目へのレビューのリンク
特定の種類の作業項目への特定の種類のリンクを作成するには、[リンク] タブを使用します。 詳細については、「作業項目のリンク (CMMI)」を参照してください。
タスク、要件、またはその他の作業項目を作成してレビューにリンクするには
レビュー作業項目のフォームを開き、[すべてのリンク] タブをクリックし、 ([新規作成]) をクリックします。
[リンクされた新しい作業項目の追加] ダイアログ ボックスが開きます。
[リンクの種類] ボックスで、[関連] をクリックするか、または追跡する関係を表す別の種類のリンクをクリックします。
[作業項目の種類] ボックスで、作成する作業項目の種類をクリックします。
[タイトル] に、簡潔かつ具体的な説明を入力します。
(省略可能) [コメント] に、追加情報を入力します。
[OK] をクリックします。
指定した作業項目の種類のフォームが開き、入力した情報が表示されます。
次のトピックで説明されているように、残りのフィールドを指定します。
[作業項目の保存] をクリックします。
1 つ以上の既存の作業項目をレビューにリンクするには
レビュー作業項目のフォームを開き、[すべてのリンク] タブをクリックし、 ([リンク先]) をクリックします。
[レビューへのリンクの追加] ダイアログ ボックスが表示されます。
[リンクの種類] ボックスで、[関連] をクリックするか、またはリンク先の作業項目の種類に基づいて、追跡する関係を表す別の種類のリンクをクリックします。
次のどれかの操作を実行します。
[作業項目 ID] に、検索する作業項目の ID を入力します。 複数の ID を指定するときは、コンマまたは空白で区切ります。
一覧から作業項目を指定するには [参照] をクリックします。
[リンクされた作業項目の選択] ダイアログ ボックスが表示されます。
[保存されたクエリ] ボックスで、追加する作業項目を含むクエリをクリックします。 たとえば、[作業項目を開く]、[アクティブなバグ]、または [アクティブなタスク] をクリックできます。
[検索] をクリックし、懸案事項にリンクする作業項目の横にあるチェック ボックスをオンにして、[OK] をクリックします。
(省略可能) リンクする項目の説明を入力します。
[OK] をクリックします。
詳細については、「リンクまたはインポートする作業項目の検索」を参照してください。
[作業項目の保存] をクリックします。
注意
リンクしたレビューと作業項目の両方が更新されます。
レビューへの詳細、添付ファイル、またはハイパーリンクの追加
追加情報は、次の方法で随時レビューに追加できます。
[詳細]、[会議メモ]、または [コメント] タブのボックスに情報を入力します。
ファイルを添付します。
たとえば、電子メールのスレッド、文書、イメージ、ログ ファイルなどのさまざまな種類のファイルを添付できます。
サーバーまたは Web サイト上に保存されている Web サイトまたはファイルへのハイパーリンクを追加します。
レビューに詳細を追加するには
[詳細]、[会議メモ]、または [コメント] タブをクリックし、ボックスに情報を入力します。
情報の書式を設定すると、強調文字や箇条書きリストを使用できます。
注意
チーム メンバーが作業項目を更新するたびに、履歴には変更日、変更を行ったチーム メンバーの名前、および変更されたフィールドが表示されます。
詳細については、「レビュー会議のフィールド (CMMI)」および「タイトル、ID、説明、および履歴 (アジャイル)」を参照してください。
[作業項目の保存] をクリックします。
添付ファイルをレビューに追加するには
[添付ファイル] タブで、次のいずれかの操作を行います。
ファイルを添付ファイル領域にドラッグします。
をクリックするか、Ctrl キーを押しながら V キーを押して、コピーしたファイルを貼り付けます。
[追加]、[参照] をクリックし、[添付ファイル] ダイアログ ボックスに、添付するファイルの名前を入力するか、参照します。
(省略可能) [コメント] ボックスには、添付ファイルに関する追加情報を入力します。 [添付ファイル] ダイアログ ボックスを閉じるには、[OK] をクリックします。
[作業項目の保存] をクリックします。
レビューにハイパーリンクを追加するには
[すべてのリンク] タブで、 ([リンク先]) をクリックします。
[リンクの種類] ボックスで、[ハイパーリンク] をクリックします。
[アドレス] ボックスで、次のいずれかの操作を行います。
リンク先が Web サイトである場合は、[アドレス] ボックスに URL を入力するか、インターネット ブラウザーから URL をコピーして貼り付けます。
リンク先がサーバーの場所である場合は、UNC アドレスを入力します。
(省略可能) [コメント] ボックスには、ハイパーリンクに関する追加情報を入力します。
[OK] をクリックします。
[作業項目の保存] をクリックします。
レビューの状態の変更
レビューによってデザインまたはコードを変更する必要がないことが確認されたら、レビュー作業項目を終了できます。 デザインまたはコードに軽微な変更または重大な変更が必要な場合は、それを解決するために開発者にアクティブなレビュー作業項目が割り当てられます。 軽微な変更のみが必要な場合、開発者はレビュー作業項目を終了できます。 重大な変更が必要な場合は、2 回目のレビューが必要になります。2 回目のレビューが正常に完了した場合にのみ、レビュー作業項目を終了できます。
チーム メンバーは次の状態を使用して、レビューの進行状況を追跡できます。
アクティブ
解決済み
終了
レビューは、アクティブ状態で作成します。
作業項目の状態を追跡するために使用できるデータ フィールドの詳細については、「割り当て、ワークフロー、および計画 (CMMI)」を参照してください。
レビューの状態を変更するには
レビュー作業項目を開きます。
[状態] ボックスで、[解決済み] または [終了] をクリックします。
状態をアクティブから解決済みに変更すると、[理由] フィールドが自動的に [軽微な変更を伴って承諾済み] に変わります。
状態を解決済みから終了に変更すると、[理由] フィールドが自動的に [軽微な変更の完了] に変わります。
[作業項目の保存] をクリックします。
通常のワークフローの流れ:
例外的な遷移:
|
レビュー状態の図 |
アクティブ (新規作成)
アクティブなレビュー作業項目は、デザイン レビューまたはコード レビューの結果を文書化します。 レビュー会議の出席者が、次に行う必要のある手順について決定します。 変更の必要がなければ、レビュー作業項目を終了します。 変更が必要であれば、レビュー作業項目はアクティブな状態のまま、適切な開発者に割り当てられます。 開発者は、変更を完了してからレビュー作業項目を解決します。
アクティブから解決済みへ
チーム メンバーは、次の表に示す理由により、アクティブなレビューを解決できます。
理由 |
使用する状況 |
追加で行う操作 |
---|---|---|
軽微な変更を行った後に受容 |
開発者がデザインまたはコードの指摘された変更を完了したとき。 |
なし。 |
重大な変更を行った後に受容 |
開発者がデザインまたはコードの指摘された変更を完了したとき。 |
レビュー作業項目を再アクティブ化します。 |
チーム メンバーがアクティブなレビューを解決すると、次のデータ フィールドがキャプチャされます。
[解決者]: レビューを解決したチーム メンバーの名前。
[解決日]: レビューが解決された日時 (サーバー クロックで記録された日時)。
[状態の変更日]: レビューの状態が変更された日時。
アクティブから終了へ
チーム メンバーは、レビュー委員会が理由のいかんにかかわらず変更は必要ないと決定した場合は、アクティブなレビューを終了できます。 [理由] フィールドは自動的に [承諾済み (現状)] に設定されます。
チーム メンバーがアクティブなレビューを終了すると、次のデータ フィールドがキャプチャされます。
[終了者]: レビューを終了したチーム メンバーの名前。
[終了日]: レビューが終了した日時 (サーバー クロックで記録された日時)。
[状態の変更日]: レビューの状態が変更された日時。
解決済み
解決済みのレビュー作業項目は、必要な変更が軽微か重大かにかかわらず完了したことを示します。 重大な変更の場合は、レビュー作業項目を終了する前に 2 回目のレビューを行う必要があります。 2 回目のレビューで追加の変更が指摘された場合は、レビュー作業項目が再アクティブ化されます。
解決済みから終了へ
チーム メンバーは、次の表に示す理由により、解決済みのレビューを終了できます。
理由 |
使用する状況 |
追加で行う操作 |
---|---|---|
軽微な変更の完了 |
軽微な変更の指摘、実行、および検証が完了したとき。 |
レビューを製品所有者に割り当てます。 |
チーム メンバーが解決済みのレビューを終了すると、次のデータ フィールドが自動的にキャプチャされます。
[終了者]: レビューを終了したチーム メンバーの名前。
[終了日]: レビューが終了した日時 (サーバー クロックで記録された日時)。
[状態の変更日]: レビューの状態が変更された日時。
解決済みからアクティブへ
解決済みのレビューは、次の表に示す理由により、再アクティブ化できます。
理由 |
使用する状況 |
追加で行う操作 |
---|---|---|
重大な変更の完了 |
問題が残っていないかどうかを検討するために、2 回目のレビューが必要なとき。 |
変更されたコードを検証するための別のレビュー会議を招集します。 |
チーム メンバーが解決済みのレビューを再アクティブ化すると、次のデータが自動的にキャプチャされます。
[アクティブ化した人]: レビューを再アクティブ化したチーム メンバーの名前。
[アクティブ化された日]: レビューが再アクティブ化された日時 (サーバー クロックで記録された日時)。
[状態の変更日]: レビューの状態が変更された日時。
終了
終了したレビューは、作業対象ではなくなります。ただし、レビューがスコープ内に戻った場合は、再アクティブ化できます。 通常は、ビジネス アナリストまたはプログラム マネージャーが、終了したレビューを再アクティブ化します。
終了からアクティブへ
終了済みのレビュー作業項目は、レビューが完了し、必要な変更がすべて完了したことを示します。 レビューが誤って終了した場合は、終了済みのレビューを再アクティブ化できます。 再アクティブ化の理由が [エラーによる終了] に設定されます。
チーム メンバーが終了済みのレビューを再アクティブ化すると、次のデータが自動的にキャプチャされます。
[アクティブ化した人]: レビューを再アクティブ化したチーム メンバーの名前。
[アクティブ化された日]: レビューが再アクティブ化された日時 (サーバー クロックで記録された日時)。
[状態の変更日]: レビューの状態が変更された日時。