知るだけで天地の差が出る、テスト仕様書の必須項目＆表現方法：誰にでも分かるSEのための文章術（12）（2/2 ページ）
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。
ここは押さえておこう！ 「確認内容の記述表現」3カ条
顧客の視点で記述する
顧客にとって、テスト仕様書は「要件定義書で定義した機能や性能がきちんと完成しているかどうか」を確認するための文書です。そのため、「確認内容」項目は、このテストが「何を確認することを目的としているか」顧客が分かるように表現します。
*** 一部省略されたコンテンツがあります。PC版でご覧ください。 ***
「正常系」テストと「異常系」テストの区分を明示する
テストでは、正常な使い方をしたケースだけでなく、例外的な使い方や誤った操作をしたケースについても、テスト項目に盛り込みます。このとき、前者と後者の区別が明確になるような記述が重要です。具体的には、テスト仕様書を見ただけで、
- 機能Aの正常な使い方・操作を確認するテスト項目
- 機能Aの誤った使い方・操作を確認するテスト項目
が一目で理解できることが大切です。
*** 一部省略されたコンテンツがあります。PC版でご覧ください。 ***
操作手順は簡潔に書く
システムの操作手順は、顧客が具体的な操作イメージをつかめるように記述します。操作手順が長く複雑になる場合は、簡潔にまとめましょう。
もし、テスト時にユーザーへ配布するマニュアルが完成しているなら、マニュアルとの対応個所を明確にします。
*** 一部省略されたコンテンツがあります。PC版でご覧ください。 ***
「確認結果」を「OK」「NG」だけで書いていないか？
「確認結果」には、テスト対象の機能・性能が定義どおりに正しく動作する場合は「OK」、バグがあって正しく動作しない場合には「NG」と、簡略化した表記で記述しがちです。
開発プロジェクト内だけで流通する文書であれば問題はないでしょう。しかし、顧客に提出する文書では、簡略化した表現は禁物です。テスト仕様書は経営陣や上級管理職が目を通す可能性があります。この場合は、表現に特に注意してください。
- OK → 問題なし
- NG → 問題あり・修正必要／問題未解決・修正必要
「確認内容」では、「テスト結果」だけでなく、「正しく動作したときのシステム状況」「バグがあって正しく動作しなかったときのシステム状況」についても同時に記述しましょう。具体的には、「画面の出力内容」「ファイルへの出力内容」「データベースの更新内容」「メール通知の内容」などです。ただし、状況の概要は簡潔に記述し、詳細は添付資料に別途まとめるとよいでしょう。
*** 一部省略されたコンテンツがあります。PC版でご覧ください。 ***
顧客用のテスト仕様書では「障害報告表番号」を削除する
テスト実施期間中は、発生した障害を管理して、障害の詳細を開発担当チームに報告します。このため、テスト項目ごとに「障害報告票番号」の記述が必要です。
しかし、顧客に提出する版では「障害報告票番号」を削除します。なぜなら、開発チーム内部で活用する情報があると分かりにくくなるからです。顧客に提出するテスト仕様書には、顧客がテスト結果を確認するために必要な情報だけを記述しましょう。
*** 一部省略されたコンテンツがあります。PC版でご覧ください。 ***
著者紹介
谷口 功 （たにぐち いさお）
フリーランスのライター、翻訳家。企業にて、ファクシミリ通信網を使ったデータ通信システム、人工知能、日本語処理関連のソフトウェア開発、マニュアルの執筆などに関わる。退職後、コンピュータ、情報処理、通信関連の書籍の執筆、翻訳、各種マニュアルや各種教材の執筆に携わる。また、通信、コンピュータ関連のメールマガジンの記事、各種雑誌においてインターネット、パソコン関連の記事やコラムなども執筆。コンピュータや通信に関連する漫画の原作を執筆することもある。 主な著作は、『SEのための 図解の技術、文章の技術』（技術評論社）、『ソフト契約と見積りの基本がよ〜くわかる本』『よくわかる最新 通信の基本と仕組み』（秀和システム）、『図解 通信プロトコルのことがわかる本』『入門ビジュアルテクノロジー 通信プロトコルのしくみ』（日本実業出版社）、『図解 ネットワークセキュリティ』『マスタリングTCP/IP IPsec編』[共著]（オーム社）など。
- システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ
- マニュアル執筆が怖くなくなる、12の執筆ポイント
- 「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める
- 知るだけで天地の差が出る、テスト仕様書の必須項目＆表現方法
- 「バグ数には興味ないのだよ」――顧客が喜ぶテスト仕様書とは？
- 論理的なプログラムを書くプログラマは、論理的な文章も書けるか？
- 文書ごとに最適な「構成のフレームワーク」は異なる
- さらば、翻訳調の文章！ 技術者向け校正ルール
- 専門用語は徹底的に「読み手指向」で書くべし
- 読みやすい文章の極意は「修飾語」にあり
- ドキュメントの質を確実に上げる6つの文章作法
- 「要件定義書のアウトライン作成」完全マニュアル
- 分かりやすい提案書はアウトラインが美しい
- ヒアリング現場で使えるコミュニケーション力
- 開発工程でSEが書く文書の基本
Copyright © ITmedia, Inc. All Rights Reserved.