テストドキュメントテンプレート
TOP >  テンプレート >  テストドキュメント作成のススメ

スペシャルコンテンツ - Special Contents - 


ドキュメント作成のメリットをご紹介

テストドキュメントの標準規格をご紹介

ドキュメント作成のススメ


本コーナーでは、ドキュメント作成の有効性について説明したいと思います。

1. ドキュメントの必要性

ドキュメントの作成作業は、全体の章構成や書く内容を考えたり、キーボードで文章をタイプしたり、マウスで図を作成したりと、なかなか手間暇がかかる作業です。

なぜ、労力をかけてドキュメントを作成するのでしょうか?

①作成者がその場にいなくても伝えられる

ドキュメントは作成者がその場にいなくても、ドキュメントを介して情報を伝えることができます。読み手が自分の都合のよいタイミングで、自分のペースで、情報を受け取ることが可能になります。 
そのためには、ドキュメントだけで正確に伝わらなければなりません。そのドキュメントだけで伝わらないドキュメントでは作成者自身による説明が不可欠となり、かえって非効率です。読み手が理解できるようなドキュメントを作成しましょう。

②一度作成しておけば繰り返し利用できる

ドキュメントは一度作成しておけば何度も繰り返して利用することができます。伝達再現性が高く、まったく同じ内容を、複数人に伝えることが可能です。
伝えるたびに作成し直す必要がなく、再利用されればされるほど、ドキュメント作成に費やした労力が低下します。

③複数人でバージョンアップができる

ドキュメントは部分的な更新(情報の追加、修正、削除)が可能で、ドキュメントの質を高めるのが容易です。また、複数の人が同じドキュメントを読み、それぞれの立場からドキュメントを更新すれば、効率的にドキュメントの質を高めることができます。

④体系的、網羅的に情報を漏れなく伝えられる

ドキュメントで伝えたい情報量が多くても、あらかじめドキュメントの構成を示すことで、読み手の全体像を把握させることができます。口頭で説明する場合は、時間的な制約のため、伝えきれない場合もありますが、ドキュメントによる情報の伝達は、時間的な制約にとらわれず、体系的、網羅的に情報を伝達することができます。


2. ドキュメント作成のコツ

①目的を考える

ドキュメントを作成するには、そのドキュメントを作成する「目的」が必要になります。

例えば、お詫び状であれば、相手に対して謝罪する、申し訳ないという気持ちを伝えるということが一番の目的になります。それらを真っ先に、そして最も強く相手の印象に残るようなドキュメントにする必要があります。

それにもかかわらず、経緯や言い訳が先に立ったり、大半を占め、謝罪の気持ちが伝わらない文章では、よいドキュメント、つまりこの場合よいお詫び状とは言えません。

②読み手を意識する

ドキュメントの作成は面倒に感じるものです。特に仕事で作成するドキュメントは、難しく、量も多く、その上で正確さも求められ、作業時間の多くを占めるため、負担に感じられるものです。そこでついドキュメントの作成を後回しにしてしまいがちです。

なぜ、ドキュメント作成は面倒に感じてしまうのでしょうか?

それは、ドキュメント作成は自分が知っていることを書き表す行為だからと言えるでしょう。ドキュメントに書く内容は、自分が考えた結果で、すでに自分が知っていることです。ですから、自分のなかで答えの出ていることについて、もう一度ドキュメントという形にするので面倒に感じるのではないでしょうか。タイプを打つスピードと考えるスピードでは、前者のほうが時間がかかるため、余計に面倒に感じるのかもしれません。

ドキュメント作成に意義が感じられるようにするには「読み手」を意識してみましょう。

ドキュメントは“何か”を“誰か”に伝える役割を持っています。このうち“何か”がすでに述べた「目的」にあたります。それに加えて“誰か”つまりドキュメントの「読み手」を意識することで、ドキュメント作成の意義が感じられるようになります。

読み手は、少し先の未来にも存在することを知っておきましょう。
開発仕様書はプログラマだけが読み手ではなく、テスト設計者も開発仕様書の読み手となります。テスト設計仕様書はテストケース作成者だけが読み手ではなく、派生開発プロジェクトのテストマネージャーが以前のテストの内容を確認する際にもテスト設計仕様書の読み手となります。テストケースはテスト実行担当者だけが読み手ではなく、類似製品開発プロジェクトのテストケース作成者が参考にする際にもテストケースの読み手となります。

また、読み手はドキュメント作成者以外の他者に限られるものではありません。数日後、数か月後の自分もまた読み手の一人であると言えます。

③今すぐドキュメントを作成しよう

ドキュメント作成のほかに進められる作業があるから、あるいは、ドキュメント作成しなくても作業は進められるから、ドキュメントを作成しようという気持ちにならないのかもしれません。

本当に今すぐドキュメント作成しなくても大丈夫なのでしょうか?

 ・今わかっていることは、後でもわかると言えるのでしょうか。
 ・今時間が確保できないのに、後で時間が確保できるのでしょうか。
 ・今作成するより、後で作成するほうが作成時間は短いのでしょうか。
 ・今は作成不要と思われるドキュメントが、後から必要にならないのでしょうか。

いずれも「No」の可能性が高いのではないでしょうか。そうであれば、今すぐドキュメント作成の時間を確保して必要なドキュメントを作成しましょう。

④ドキュメントのフォーマットを見直そう

上記のような、読み手が理解しやすい目的に合ったドキュメントを作成するには、そのフォーマットや、書くべき項目をよく考える必要があります。

すでに運用されているドキュメントのフォーマットが使いにくかったり、書きにくいフォーマットを使用しているために、ドキュメント作成を面倒に感じているのかもしれません。そうした場合は、ドキュメントのフォーマットを見直してみるのも一考です。

 ・今作成しているドキュメントが本当に必要か。
 ・今作成しているドキュメントの項目に過不足はないか。
 ・今作成しているドキュメントの記述は大まかすぎないか。
 ・今作成しているドキュメントの書き方はわかりやすいか。
といったポイントで見直し、適切なドキュメント作成を行いましょう。

理由はわからないがフォーマットがあるから、理由はわからないが書くことになっているから、というだけでドキュメント作成していては無駄が発生します。貴重な時間を費やすのに見合う有効性のあるドキュメント作りをしましょう。


3. テストドキュメント

これまで述べてきたことをソフトウェア開発におけるテストドキュメントに当てはめてみましょう。

①テストドキュメントの目的

 テストの考え方、テストで確認すること、テスト実施の結果を伝えること

②テストドキュメントの読み手

 ・テスト担当者
 ・テスト実施で発生した不具合を修正する開発担当者
 ・テスト結果からリリース判定を行うプロジェクトマネージャーなど

③テストドキュメントの種類

 ・テスト計画書
 ・テスト設計仕様書
 ・テストケース
 ・テスト結果
 ・テストログ
 ・不具合報告書
 ・テスト報告書
 ※標準規格 IEEE829-2008 ではもう少し詳細にテストドキュメントの種類や目次が定義されています。

テストのさまざまな作業に合わせてその成果としてテストドキュメントを作成します。それぞれのドキュメントの種類について、さらに目的と読み手を意識して作成しましょう。


4. テストドキュメントの活用

テストドキュメントを工夫して活用することにより、下記のような効果が期待できます。
 ・テストの全体像が把握でき、テストに要する要員や時間などの見積もりが可能になる
 ・テストの意図・目的が明確になるため、適切なテスト実施が可能になる
 ・仕様変更に合わせて、テスト内容を適切に変更・メンテナンスできるようになる
 ・テストのノウハウが個人に依存せず保存・継承でき、発展させることができる
 ・派生開発や類似機能のテストで再利用することができる

ドキュメントにするということは、レビュー可能になるということでもあります。適切な粒度でテスト内容をテスト設計仕様書としてまとめておくことで、短いレビュー時間で、テストのモレ抜けが無いかをレビューしやすくなります。
また、テスト設計仕様書と開発仕様の関連付けができていれば、仕様変更があった場合、その変更を即座にテスト内容に反映することができます。テストドキュメントは開発工程間で生じる品質劣化を防ぐ効果もあると言えます。

テストドキュメントがあれば、開発中のソフトウェアの品質を客観化するだけでなく、そのソフトウェアを作り出す開発プロセスの品質をも、分析、改善することができます。
テストドキュメントを通じて開発プロセスを向上させることで、結果としてソフトウェア品質そのものを向上させていく、この意識をもって素晴らしいドキュメントを作っていきましょう。






テンプレート投稿 - Template Submission - 

このサイトにあなたのドキュメントのテンプレートやサンプルを掲載しませんか?
ドキュメント作成にお悩みの方々に、あなたのお気に入りのテンプレートをご紹介下さい。投稿をお待ちしています。