はじめに
以前こちらの記事で言及した通り、プロジェクトの内容（テスト対象の情報）を正しく理解できていないことはテスト漏れの原因になります。
読みやすいドキュメントを準備するなどして関係者の認識齟齬を防げるのが理想ですが、リソースやスキル不足など何らかの原因で読みやすいドキュメントを準備するのが難しい場合もあります。
そこで本記事では、ドキュメントの記載内容に対して見落としや誤解を防ぐためのコツをいくつかご紹介します。
なお、実際の業務ではドキュメントに記載のない情報を追加で集めたり、ドキュメントを読んで仕様の問題点を指摘できる必要がありますが、本記事の対象外となります。
読んだ内容を忘れないようにする
ドキュメントの内容をしっかりと記憶に定着させるためには、ただ文章を読むだけでなく、読んだ内容に関して何らかのアウトプットを行ったほうが効率的なようです。
私が文章量の多いドキュメントを読む際は、ノートに手書きで情報をメモすることが多いです。
ドキュメントを2回読む方もいますね。1回目はざっと全ての文章に目を通して全体像を把握し、2回目に読むときに重要な情報をメモする流れです。
参考
無意識の読み飛ばしを防ぐ
私たち人間は、文章を読む際に文章の一部を 無意識 に読み飛ばしてしまうことがあるそうです。
読み飛ばしを防ぐためには、以下のような方法があります。
- 音読する
- 音読だと知らない言葉を読むときにスムーズに読めないことが多いそうです。自分が理解できていない文章に気づくことができます
- 読んだ内容を要約したメモを書く
- 文章の意味を考えなければいけないため、読み飛ばしが減るようです
私の場合は、以下のようなことを実践しています。
- 頭の中での音読して文章を読む[1]
- テストに関係する情報（テスト対象の構造、入力、入出力を決めるロジック、出力内容、参照・更新するデータなど）[2]を意識して情報を集め、テスト対象やテスト条件などをツリー構造で整理しながら文章を読む
参考
言葉の意味の誤解を防ぐ
ドキュメントの書き手が言葉で伝えたいことを正しく理解するには、単に書かれている単語の意味だけでなく、その単語が書かれた背景まで理解する必要があります。
例えば、「ユーザー」という単語はシステムを利用する人を指しますが、「管理者」「一般利用者」「API経由のシステム」「特定の権限を持つユーザー」など、文脈によって指す対象が異なります。そして、「ユーザー」の意味をどのように理解するかは、読み手の知識や経験によって大きく左右されます。
そのため、ドキュメントの内容を正しく理解するためには、テスト対象となる機能の目的、プロダクトのドメイン知識、誰がどのようにプロダクトを使うかといった背景まで知っておく必要があります。
私は特に新しいプロダクトを担当するときは以下のようなことを行います。
- プロダクトのドメイン関する書籍や営業資料などを読む
- プロダクトの機能一覧や機能の使い方を調べる
- 新たに開発する機能について、開発する目的を調べる
参考
自分の理解を他の人に共有する
上記のような努力をしても、ドキュメントの内容を見落としたり誤解したりすることがあります。
もし自分の理解に自信がない場合は、自分の理解を 自分の言葉に言い換えて 他の人に共有し、認識が正しいかを確認する方法があります。
ドキュメントに記載されている表現をそのまま使ってしまうと、前述の単語の意味の誤解を確認することができないので注意してください。
おわりに
本記事ではドキュメントの記載内容に対して見落としや誤解を防ぐためのコツをいくつか紹介しました。
自分がミスをする時の思考のクセなどを知るとミスを減らせる可能性があります。
もし皆さんが活かせそうなものがあれば、ぜひ試してみてください！
Discussion