レビュー時のチェックリストは、以下の2点の内容を一覧表にまとめたものである
「第3部 レビュー」の2章に記した「レビューのポイント」の「レビューのコツ一覧」¾
プロジェクトにおいて採用することとなった「第3部 レビュー」の2章「レビューのポイント」に記した「レ ビューのコツ」について、レビューを実施する際に確認できるよう、チェックリストの形式に整理した¾
「レビューのコツ」に対応するコツIDをチェックリストの「コツID」欄に記述した
設計書を作成する上で積極的に確認すべき観点¾
主に、 「第3部 レビュー」の2章「レビューのポイント」の検討過程において、"コツには至らないが、 重 要な観点である"と判断した事項を集約したものである。このため、各チェック項目内容にはばらつきが あるためご留意いただきたい¾
「レビューのコツ」との判別のために、チェックリストの「コツID」欄には「－」を記述した レビュー時のチェックリストは、「第3部 レビュー」の1章 1.1「分類」の考え方、1.2レビュー の考え方に記述した7つの「コツの分類」により整理されており、各チェック項目に対する 補足説明を補足事項欄に記している
1.
「コツの分類」に関する事項¾
各「コツの分類」に対し個別に確認すべき事項。 「コツの分類」ごとに確認する2.
「コツの分類」について共通的な事項¾
各「コツの分類」に対して共通に確認すべき事項。各「コツの分類」に限らず共通的に確認する レビュー実施過程における備忘録として、またはレビュー実施時の確認リストとして、プロ
ジェクトにおいて適宜具体的なチェック方法に置き換えてご使用いただきたい
く進められる。
2
共通の確認 のコツ
ヒアリング一覧表を作成して効率よく、もれ なく確認する
レビューの前にヒアリング一覧表を作って、
確認ポイントを整理しておくと、レビューを効 率よく進められる。またレビュー時にチェック リストとして使用して確認もれをなくせる。
―
3
エンティティ・
属性を抽出 するコツ
業務の中で利用する"モノ"に着目して、
データや情報を抽出・分類する
業務の中で利用する"モノ"を抽出・分類し、
発注者と認識をあわせておくと、エンティティ の洗い出しがしやすい。
MR1001
4
エンティティ・
属性を抽出 するコツ
業務用語辞書を元にしてデータ辞書を作 成する
発注者と開発者間でデータ項目の意味の認 識がずれることを防止する。
発注者が業務で使っている用語を適用する ことで、会話がスムーズになる。
MR1002
5
エンティティ・
属性を抽出 するコツ
データ項目の型／桁／精度はドメイン定義 書で確認する
大量のデータ項目の型／桁／精度を全て確 認するよりも、ドメインを確認するほうが効率 がよい。
また、データ項目整理の際に、異音同義語を 明確にできる。
MR1003
6
エンティティ・
属性を抽出 するコツ
データ項目の情報はコード定義書に記述し て確認する
コードの構成や連番の規則に含まれた業務 ルールを洗い出し、コード定義書にまとめ る。
MR1004
7
エンティティ・
属性を抽出 するコツ
エンティティを識別する主キーに過不足が ないか確認する
必要十分な主キーを洗い出すことで、エン ティティ間の関係やカーディナリティが明確に なるため、業務で作成されるデータと整合性 が取れているかを確認しやすくなる。
―
8
エンティティ・
属性を抽出 するコツ
単語辞書に単語の利用方法を記述して確 認する
単語の利用方法(主語／修飾語／区分語)を 決めることで、ネーミング基準と単語辞書を 利用したデータ項目名の標準化が行いやす くなる。
―
9
エンティティ・
属性を抽出 するコツ
単語辞書に単語の異音同義語を併記して 確認する
単語の別の呼び名(異音同義語)を併記し、
異音同義語がデータ項目名に使われないよ うにすると、データ項目名の標準化が行いや すくなる。
―
ID コツの分類 コツの説明 コツの補足 コツID プロジェクトにおける採用方針 適用確認欄
10
エンティティ・
属性を抽出 するコツ
データ項目やドメインを、名称の接尾語を 用いて分類する
データ項目が属しているドメインや、ドメイン の種類を、定義書を見なくても判断できるよ うになる。レビュー中に定義書を見る頻度を 減らせるため、レビューを円滑に進められ る。
接尾語の例を以下に示す。
・ドメイン名の接尾語に区分語を使用 デ
―
11
エンティティ・
属性を抽出 するコツ
数値の属性に対する端数処理を確認する 複数機能から数値の属性が更新される場合 に、機能間で端数処理に違いがあると、原因 が特定しづらい障害が発生しやすい。
業務に精通した人にしか判断できないため、
早い段階で確認する。
―
12
データモデ ルの概要を 説明するコ ツ
データモデルの概要を業務や大きな機能 レベルでまとめてエンティティの候補を確 認する
発注者がエンティティの候補を確認する際、
自分の関係する業務に集中して確認するこ とでエンティティの過不足や不整合を発見し やすくなる。
業務ごとにエンティティの候補を抽出していく ため、機能間の連携で用いるエンティティが 特定しやすくなる。
MR2001
13
データモデ ルの概要を 説明するコ ツ
扱うエンティティをグルーピングした資料を 作成して確認する
全体に着目して各業務の構成をレビューし、
それぞれの担当者を確定する。
業務間の連携を確認しやすくなる。
発注者は自分の関係する業務に集中して確 認できる。
MR2002
14
データモデ ルの概要を 説明するコ ツ
システムが扱う情報を俯瞰できる資料を作 成し、システムが扱う情報の範囲を確認す る
システム化業務だけではなく作業もあわせて 記述すると、システムが扱う情報の範囲を確
認しやすい。 MR2003
15
データモデ ルの詳細を 説明するコ ツ
実データを例に使って、工程成果物の読み 方を説明する
ER図の読み方を発注者になじみ深い凡例を 使用して説明するとわかりやすい。
MR3001
16
データモデ ルの詳細を 説明するコ ツ
データモデルに、実データを当てはめて補 足する
わかりにくい構造や、新規要件を表すエン ティティに、具体的な値をあてはめて、個々 の確認事項を明らかにする。
タイミングや条件に応じて多重度が変わる ケースなど、データモデルだけでは表現しに くい構造も、 確認の対象とする。
MR3002
説明するコ ツ
しやすい。
18
データモデ ルの詳細を 説明するコ ツ
データモデルを画面や帳票を使って説明 する
ER図自体はレビューの参加者に見せず、対 応している画面・帳票を使用して、ER図を作 成するのに必要な情報をヒアリングする。 ―
19
データモデ ルの詳細を 説明するコ ツ
ER図上のエンティティをレビュー対象の業 務で囲む
レビュー対象とする業務で扱うデータ（エン ティティ）を探し出しやすくなり、レビューをス
ムーズに進められる。 MR3004
20
データモデ ルの詳細を 説明するコ ツ
画面でデータを作成するか／しないかでエ ンティティを区別する
画面からの操作でデータを作成するエンティ ティに着目してレビューを行う。そのレビュー 時点では、バッチ処理でデータを作成するエ ンティティはレビュー対象外とする。
レビュー対象外のエンティティは背景色をグ レーにするなどし、目立たなくさせるとよい。
MR3005
21
データモデ ルの詳細を 説明するコ ツ
発注者への確認事項をER図にコメントとし て直接記述し、議論のポイントを明らかに する
以下に確認ポイントの例を示す。
・発注者への確認事項
・ER図作成の際に議論となったポイントや経 緯のメモ
MR3006
22
データモデ ルの詳細を 説明するコ ツ
ER図の変更は、変更理由とともに履歴を 残す
保守・機能拡張の際に重要となるデータモデ ル変更の経緯を残す。
―
23
データモデ ルの詳細を 説明するコ ツ
新規要件への対応箇所をレビューポイント としてER図上で明らかにしておく
ビジネスプロセスの変化への柔軟性、といっ た画面や帳票で表現しにくい要件への対応
をデータモデルで表す。 MR3007
24
データモデ ルの詳細を 説明するコ ツ
新規要件に伴うER図の変更は、変更前／
後を比較して効果を説明する
変更前との相違により、新たに導入されるエ ンティティの役割や使用される業務をイメー
ジしやすくなる。 MR3008
25
データモデ ルの詳細を 説明するコ ツ
旧システムと新システムのレコード移行の 方針について業務内容の観点で図示して 説明する
複数のテーブルをまとめて新たにテーブルと する、または、１つのテーブルを別テーブル に分割するなどを図示すると、移行の概要を 示せる。
MR3009
ID コツの分類 コツの説明 コツの補足 コツID プロジェクトにおける採用方針 適用確認欄
26
データモデ ルの詳細を 説明するコ ツ
業務とエンティティのまとまりとの対応を示 し、データモデルの読み方を説明する
ER図と機能の対応関係を示すと、業務とエ ンティティの関係がわかりやすい。
業務の理解は深いが、ER図には慣れていな い発注者がER図全体をレビューする必要が ある際、業務の観点からER図を読む方法を 示すことで、理解しやすくなる。
MR3010
27
データモデ ルの詳細を 説明するコ ツ
他の設計ドキュメントでエンティティ名を記 述する場合、区別できる表現にする
エンティティ名や属性名はあらゆる設計ド キュメントで使用されるので、対応を明らか にするために 【】で囲むなど識別できる表現 にし、ER図と併用し参照して頂く。
MR3011
28
データモデ ルの詳細を 説明するコ ツ
他のガイドラインの工程成果物中で参照し ているエンティティと属性の名称を、データ モデルのエンティティ名と属性名に揃える
レビューでは、複数の種類の工程成果物を 参照しながら説明する。その際に、エンティ ティと属性の名称に差異があると、工程成果 物間の関係がわかりづらくなる。
―
29
データモデ ルの詳細を 説明するコ ツ
エンティティが多く複雑で、一枚で俯瞰でき ない場合は概略のER図を作成する
仕掛期に概略のER図を描いている場合も、
エンティティを抽出した後、当初想定した構 造が妥当かどうか見直す。
主要なエンティティを抽出し、その関係を表 す、あるいは業務単位に分類し、各業務の 関係図として表すなどの方法がある。
MR3012
30
データの変 化を確認す るコツ
実データ例を使用しながら、処理とデータ 生成の流れを記述した資料を用意し、機 能を確認する
実データ例を使用した平易な図などを用意 することにより、機能に対する理解を促進で きる。
MR4001
31
データの変 化を確認す るコツ
積層棒で状態遷移を作成して、確認する 数量の推移と状態の関連が視覚的に表現さ
れているためわかりやすい。 MR4002
32
データの変 化を確認す るコツ
状態遷移図でエンティティの取り得る状態 を図示する
処理後の取り得る状態を整理し、かつ複数
の区分値の関係を表現できる。 MR4003
33
業務とデー タの関係を 確認するコ ツ
設計書の処理単位に、処理概要、設計内 容とともにC,R,U,Dもあわせて記述する
CRUD図のようにエンティティと機能の関係を 俯瞰することはできないが、処理単位にアク セスするエンティティをC,R,U,Dで記述するエ ンティティへのアクセスが一目で確認でき る。
MR5001