連載
» 2011年07月06日 00時00分 UPDATE

文章コミュニケーション・リファクタリング!(5):技術や製品の調査報告書では特に結論を簡潔に (1/3)

「文章下手」が原因で、コミュニケーション不全に陥ったことはないだろうか? 言葉足らずで相手の誤解を招いたり、指示がまったく伝わっていなかったり……開発現場を改善するための「文章コミュニケーション」方法を紹介。

[谷口功,@IT]

 前回は、不定期に発生するイベント、特にトラブルについて記述するときに注意すべきポイントを説明しました。今回は、技術や製品などについて調査した結果をまとめる報告書の書き方を解説します。

 技術や製品の調査報告書も、不定期のイベントに応じて記述する報告書と同じものと考えられます。書き方や表現が書き手の裁量に任されるため、トラブル報告書と同様に、文章コミュニケーションの点で問題が発生しやすいものです。

調査報告書は学術論文ではない

 エンジニアは、コンピュータシステムを開発するときに、そのシステムで利用しようと考えている技術や製品(ソフトウェア、ハードウェア)について調査することがあります。その技術や製品が本当に役立つのか調べ、結果を顧客に報告するのです。

 このような報告文書は、技術を検証、検査、試験した結果を報告するものであるため、エンジニアは、テスト仕様書や技術、製品の論文やレポートと同じように記述してしまいがちです。調査対象の技術や製品の詳細な技術的解説や、実施した検査、試験の詳細な結果を記述した文書になってしまうのです。

 しかし、調査報告書は、調査試験の報告書でも、対象となる技術や製品そのものについての報告書や論文でもありません。調査報告書は、対象となる技術や製品が、システムで利用可能なのかそうでないのかという一点について報告するものです。顧客(読み手)も、それを求めています。

 また、これはエンジニアに限ったことではありませんが、調査報告書を記述するときに、報告者(書き手)がやってしまいがちなのが、調査の理由、調査の経緯や調査において自身が実行したことなど、調査に関連する事柄を最初から順番に詳しく記述することです。

 報告する側としては、調査をきちんとしたことを示したい、調査結果や結論を正確に把握してもらうには、調査の全容をきちんと提供しないといけないと考え、調査内容を時系列に沿ってすべて記述してしまうのでしょう。しかし、顧客の、特に上級管理職や経営陣が必要とするのは、調査の要点です。調査報告書には要点だけを簡潔に記述しなければなりません。

形式に従って書けばよい

 調査報告書は簡潔でなければなりません。しかし、次のような冗長な調査報告書を作ってしまいがちです。

 新しい技術を採用した画像認識ソフトウェア製品◎◎が、今回開発するシステムで利用可能かどうかを調査いたしました。
 ◎◎が採用する画像認識技術は、△△を取り入れたものであり、これまでの画像認識に比べて相当にレベルの高い認識が可能です。
<以下、についての長く詳細な技術的特長を記述>
   :
 ◎◎は、このような特長を備えたを採用しており、これを利用できれば、今回開発するシステムに大きなメリットをもたらすと期待できます。
 しかし、新しい技術を採用した製品であるため、本当に利用可能かどうかを検証する必要があります。
 検証は、開発システムが運用される状態を想定して、できるかぎりそれに近い状態で実施しました。
<以下、調査方法、検証環境、作業手順、作業項目を詳細に記述>
   :
 調査はさまざまな前提、条件に分けて、前提、条件ごとに完全に実施しました。前提、条件ごとの動作状況と調査の結果は次のようになります。
<以下、調査の経過と結果を詳細に記述>
   :
 さて、調査を総括すれば、非常に好感触な結果が得られたと言えるでしょう。新しい技術を採用したソフトウェア製品◎◎を開発システムで利用しても問題はないと考えられます。


 上記の例を見ると、調査の報告者が自分の行動、すなわち調査活動を時系列でそのまま記述しただけのものになっています。このような長くてメリハリのない文章では誰も読んでくれません。また、技術的な事柄を、専門的な、エンジニアのレベルで、詳細に記述しているのも問題です。

 調査報告書には、基本的な形式があります。この形式に沿って記述することが、簡潔で、きちんと伝わる文書にするための第一歩です。また、文書としてのメリハリも付きます。

 調査報告書は、調査の目的調査の方法調査結果結論(または考察)の4項目を記述する必要があります。これらを、下記の構成例のように、1つ1つの項目に分けて構成し、読みやすい文書にするのです。

 新しい技術を採用した画像認識ソフトウェア製品◎◎が、今回開発するシステムで利用可能か調査し、その経過と結果を以下の通りに報告いたします。

1 目的
調査の目的(どのようなことを結論付けるために調査を実施するのか)を簡潔に記述

2 調査
方法調査の方針、調査手順、調査を実施した環境などを簡潔に記述

3 調査結果
調査の結果を簡潔に記述

4 結論
調査の目的に対応した、調査の結果から考察できる結論を記述


       1|2|3 次のページへ

Copyright© 2014 ITmedia, Inc. All Rights Reserved.

TechTargetジャパン

Nexus 6と格安SIM、プレゼント!
Loading

ホワイトペーパー(TechTargetジャパン)

注目のテーマ

転職/派遣情報を探す

【転職サーチ】SIer/Web企業/新規事業 スマホ開発で、あなたのキャリアを生かす

「派遣・フリーで働くメリット」とは? 活躍する派遣エンジニアの本音

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。