14
X 20246 : 2021 (ISO/IEC 20246 : 2017)
附属書A
(規定)
レビューの文書化
A.1 概要
この附属書では,要検討事項ログ,インシデント報告書及びレビュー報告書に含めなければならない情
報について規定する。しかし,具体的な記録のためにここで提供する命名体系を利用することは必須では
なく,他の用語を使用してもよい。実際には,これらは単一の文書として発行する必要はなく,電子形式
で利用可能としても,別々の文書に分割しても,又は他の文書と組み合わせてもよい。
非形式的レビューが行われる場合,この附属書に定義した形式的な文書化は必要ない。
表A.1は,レビューの文書化に対する要求事項を,各文書に固有の情報ごとにまとめたものである。こ
れらの文書種別のそれぞれの例を,附属書Bに示す。
表A.1−レビューの文書化における規範的要求事項の要約
情報項目(この規格) 規範的要求事項
A.2 要検討事項ログ
i) 一意の識別子 要求(Shall)
ii) 日付及び時刻 要求(Shall)
iii) 説明 要求(Shall)
iv) 重要度 要求(Shall)
v) 要検討事項の状態 要求(Shall)
vi) 要検討事項の割当て 要求(Shall)
vii) 要検討事項の解決策 許容(May)
A.3 インシデント報告書
i) 発見日時 要求(Shall)
ii) 指摘者 要求(Shall)
iii) 状況 要求(Shall)
iv) インシデントの説明 要求(Shall)
v) 重要度 要求(Shall)
vi) 優先度 要求(Shall)
vii) リスク 要求(Shall)
viii) インシデントの状態 要求(Shall)
A.4 レビュー報告書
i) 作業生産物の説明 要求(Shall)
ii) 参加者 推奨(Should)
iii) レビュー結果の要約 要求(Shall)
iv) レビューメトリクス 許容(May)
v) 作業生産物の評価 要求(Shall)
――――― [ pdf 16] ―――――
15
X 20246 : 2021 (ISO/IEC 20246 : 2017)
A.2 要検討事項のログ
A.2.1 概要
要検討事項のログには,個々人のレビュー中に識別された要検討事項の一覧を含む。
A.2.2 文書固有の情報
A.2.2.1 概要
この情報は,文書を識別し,その初版及び履歴を記述する。
例 この情報は,文書の前の方のページに,又は内容が電子形式で,例えば,データベースに保存され
ている場合は,中心的な位置に置くことが可能である。
A.2.2.2 文書の一意な識別
文書の版を一意に識別する。
例 一意な識別子は,文書のタイトル,発行日,版,及び/又は文書の状態(例えば,草稿,レビュー
済,修正済,最終)を含むことが可能である。
A.2.2.3 発行組織
文書の準備及びリリースの責任を負う組織を指定する。執筆者及びテスト担当者を含めてもよい。
A.2.2.4 承認者
文書のレビュー及び承認署名(電子署名でも可)の責任を負う,指定された人物を識別する。レビュア
及び関連する管理者を含めてもよい。
A.2.2.5 変更履歴
文書の発行以来発生した全ての変更のログを含む。
例1 これには,文書の現在の版及びそれぞれ一意な識別をもっている旧版文書の一覧,一覧内の以前
の文書に対する変更の説明,変更の理由,変更を加えた人の名前及び役割などが含まれる。
例2 変更の理由には,監査コメント,チームレビュー,システム変更などが含まれ,変更を加えた人
には,文書の執筆者,プロジェクト管理者,システム所有者などが含まれる。
A.2.3 はじめに
文書の背景及び構造に関する説明情報を提供する。
A.2.3.1 範囲
文書による問題領域の網羅範囲を識別し,包含,除外,前提,制限などの全て,又は一部を記述する。
A.2.3.2 参考文献
参照先の文書を列挙し,システム,ソフトウェア及びテスト情報のリポジトリを識別する。参照は,組
織外からの“外部”参照と,組織内からの“内部”参照とに分けられる。
――――― [ pdf 17] ―――――
16
X 20246 : 2021 (ISO/IEC 20246 : 2017)
A.2.3.3 用語集
文書で使用されている用語及び略語があれば,その語彙集を提供する。
注記 この細分箇条は,附属書でもよいし,又は一般的な用語集として提供される別の文書を参照して
もよい。用語集及び/又は略語一覧の全部又は一部をオンラインにしてもよい。これは,個別の
テスト作業固有の用語集としてもよいし,又はより大きな組織の用語集(テスト作業関連のもの
よりも多くの用語を含む。)に組み込まれていてもよい。
A.2.4 要検討事項
A.2.4.1 概要
レビュー実施中に識別された重要な要検討事項を列挙する。要検討事項について記録された情報は,通
常はレビューが進むにつれて増加し,要検討事項に関するより詳細な情報が得られるようになる。例えば,
“要検討事項の状態”及び“要検討事項の割当て”は,“要検討事項の共有及び分析”アクティビティ(6.4.4
参照)内で記録するのが一般的であり,残りの情報は,通常これより前の“個々人のレビュー”アクティ
ビティ(6.4.3参照)内で記録する。
要検討事項ログに記録する各要検討事項の情報をA.2.4.2A.2.4.8に示す。
A.2.4.2 一意の識別子
要検討事項ログのエントリの連番を定義する。
A.2.4.3 日付及び時刻
要検討事項が識別された日時を定義する。
A.2.4.4 説明
要検討事項について説明する。これには,使用されているシナリオ,役割,確認項目など,レビューの
背景への参照が含まれていてもよい。
注記 要検討事項の説明には,提案された解決策が含まれる場合がある。
A.2.4.5 重要度
この要検討事項が文書に与える影響の深さ及び大きさを,レビュアの視点から示す。これには,関連す
る欠陥を修正するために必要な時間及び労力の見積りを含めてもよい。
注記1 ここでの文書は,レビュー対象の作業生産物,組織全体の標準などの補足書類の場合がある。
注記2 要検討事項の重要度は,要検討事項ログを対処の優先順位に従って列挙するときに利用するこ
とがある。
A.2.4.6 要検討事項の状態
要検討事項の状態を示す。これは,通常,“要検討事項の共有及び分析”アクティビティ(6.4.4参照)中
に割り当てる。
例 要検討事項の状態の典型的な例は,“却下”,“注意すべき要検討事項はあるがアクションはない”,
“対処すべき要検討事項”,及び“分析によって更新された要検討事項”である。
――――― [ pdf 18] ―――――
17
X 20246 : 2021 (ISO/IEC 20246 : 2017)
A.2.4.7 要検討事項の割当て
要検討事項の対処における責任者を示す。
例 この責任者は,通常は要検討事項が関連しているレビュー対象作業生産物の執筆者であるが,要検
討事項が組織全体の標準などの補足書類に関連しているときは,レビュー外部のチームの場合があ
る。
A.2.4.8 要検討事項の解決策
必要に応じて要検討事項の解決案を説明するが,これは,即座に明らかにはならない。
注記 これは,要検討事項のより詳細な分析によって,以前に同意されたレビュー処置が不適切又は不
十分であることが判明した場合に必要となることがある。
A.3 インシデント報告書
A.3.1 概要
インシデントは,現在のレビュープロセス内で要検討事項に対処できない場合,又はレビュー中の作業
生産物以外の文書で要検討事項を識別した場合に報告する。
インシデント報告書は,文書内の一覧若しくは表に記録するか,又はツール,例えば,データベース若
しくは専用のバグ追跡ツールを使用して記録することが可能である。
インシデント報告書の形式は,インシデント管理プロセスの一部など,組織内の他の場所で定義され,
その定義の使用が必要となる場合がある。
ここでのインシデント報告書は,レビュー中に認められたインシデントを文書化するものである。
注記1 インシデントは,他の状況,例えば,動的テスト作業中に発生し,報告される可能性がある。
注記2 ここに記載されている情報は,インシデント報告書が最初に提出されたときに必要な情報だけ
である。インシデント報告書が後続のインシデント管理プロセスを通過するにつれて,より多
くの情報がそこに追加され得る。
A.3.2 文書固有の情報
A.3.2.1 概要
この情報は,文書を識別し,その初版及び履歴を記述する。
例 この情報は,文書の前の方のページに,又は内容が電子形式で,例えば,データベースに保存され
ている場合は,中心的な位置に置くことが可能である。
A.3.2.2 文書の一意な識別
文書の版を一意に識別する。
例 一意な識別子は,文書のタイトル,発行日,版,及び/又は文書の状態(例えば,草稿,レビュー
済,修正済,最終)を含むことが可能である。
――――― [ pdf 19] ―――――
18
X 20246 : 2021 (ISO/IEC 20246 : 2017)
A.3.2.3 発行組織
文書の準備及びリリースの責任を負う組織を指定する。執筆者を含めてもよい。
A.3.2.4 承認者
文書のレビュー及び承認署名(電子署名でも可)の責任を負う,指定された人物を識別する。レビュア
及び関連する管理者を含めてもよい。
A.3.2.5 変更履歴
文書の発行以来発生した全ての変更のログを含む。
例1 これには,文書の現在の版及びそれぞれ一意な識別をもっている旧版文書の一覧,一覧内の以前
の文書に対する変更の説明,変更の理由,変更を加えた人の名前及び役割などが含まれる。
例2 変更の理由には,監査コメント,チームレビュー,システム変更などが含まれ,変更を加えた人
には,文書の執筆者,プロジェクト管理者,システム所有者などが含まれる。
A.3.3 はじめに
文書の背景及び構造に関する説明情報を提供する。
A.3.3.1 範囲
文書による問題領域の網羅範囲を識別し,包含,除外,前提,制限などの全て,又は一部を記述する。
A.3.3.2 参考文献
参照先の文書を列挙し,システム,ソフトウェア及びテスト情報のリポジトリを識別する。参照は,組
織外からの“外部”参照と,組織内からの“内部”参照とに分けられる。
A.3.3.3 用語集
文書で使用されている用語及び略語があれば,その語彙集を提供する。
注記 この細分箇条は,附属書でもよいし,又は一般的な用語集として提供される別の文書を参照して
もよい。用語集及び/又は略語一覧の全部又は一部をオンラインにしてもよい。これは,個別の
テスト作業固有の用語集としてもよいし,又はより大きな組織の用語集(テスト作業関連のもの
よりも多くの用語を含む。)に組み込まれていてもよい。
A.3.4 インシデントの詳細
インシデントを最初に認識して報告するときの情報には,次のものを含む。
A.3.4.1 発見日時
インシデントが最初に観察された日付(場合によっては時刻を含む。)を記録する。
A.3.4.2 指摘者
インシデントを識別した個人の名前及び肩書を指定する。
――――― [ pdf 20] ―――――
次のページ PDF 21
JIS X 20246:2021の引用国際規格 ISO 一覧
- ISO/IEC 20246:2017(IDT)