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

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

[谷口功,@IT]

目的は調査そのものではない

 当たり前ですが、調査の目的は、調査を実施することではありません。調査の結果に基づいて、調査対象である技術や製品に対して的確な判断をすることです。調査報告書の「目的」の項目を記述するときは、そのことを忘れてはなりません。

 新しい技術を採用した画像認識ソフトウェア製品◎◎の動作、機能および性能を、今回開発するシステムをシミュレートしたシステム上で調査します。


 上記の文章では、動作や機能、性能を調べることが目的であるように書いてしまってします。調査の目的は、製品が開発システムに利用できるかどうかを確認し、判断することです。ほとんどの場合、エンジニア自身はそのような目的を認識しているでしょう。そして、そのような目的を持って調査を実施するはずです。

 しかし、そのことを報告書にきちんと記述しないと、読み手(顧客)には伝わりません。上記のような記述では、読み手は、報告者が単に製品を動かしてみただけだと認識してしまうでしょう。“確認、判断”のために調査を実施したことを文章として明示しておかなければ誤解の元となります。

 新しい技術を採用した画像認識ソフトウェア製品◎◎の動作、機能および性能を、今回開発するシステムをシミュレートしたシステム上で検証し、開発システムで利用可能かどうかを確認、判断します。


技術的な詳細を記述する必要はない

 作業手順、操作手順、動作環境といった事柄は、エンジニアの得意な領域です。このため、動作環境について詳細な技術情報を記述したり、操作手順、作業手順を具体的、詳細に記述したりしがちです。そのように記述すると必然的に、技術用語や専門用語を多用した表現になってしまいます。

 調査は、実際の業務をシミュレートできる疑似システムを構築し、その上で実施しました。
●調査環境
以下のような環境で調査しました。
・ソフトウェア環境
   <以下、詳細な技術情報を記述>
 ・ハードウェア環境:
   <以下、詳細な技術情報を記述>
 ・ネットワーク環境:
   <以下、詳細な技術情報を記述>
 ・使用データ
   <以下、技術用語を使って詳細に記述>
●調査手順
調査項目ごとに、以下のような作業手順で対象ソフトウェアを動作させ、調査しました。
●調査区分1
 ・調査項目A  <作業手順の記述>
 ・調査項目B  <作業手順の記述>
      :
●調査区分2
 ・調査項目M  <作業手順の記述>
 ・調査項目N  <作業手順の記述>
    :
 <以下、すべての調査項目について、調査で行った作業の手順を詳細に記述>


 上記の例を見ると、調査を実施した環境や作業手順を、技術用語や専門用語を使って詳細に記述しています。このような文章を手にした上級管理職や経営陣は、一目見ただけで投げ出してしまうでしょう。顧客が知りたいのは、実際に導入するシステムで対象ソフトウェアを利用した時にきちんと機能するかどうかです。実際のシステムを使った業務を想定した調査方法で調べているのかを知りたいはずです。

 調査方法は、実際にシステムを利用する業務と関連づけて簡潔に記述します。このとき、調査に使用したハードウェア環境、ソフトウェア環境、ネットワーク環境、使用したデータの詳細、調査項目ごとの調査における詳しい作業手順や操作手順などは、別紙に参考資料として添付します。また、専門用語は使わないようにします。顧客の上級管理職や経営陣が読んでも分かるような言葉を使います。

 実際の業務で対象ソフトウェアを使用する状況を疑似的に構築し、業務システム環境において、業務と同じ作業手順によって調査を実施しました。
 調査環境、調査項目ごとの作業手順の詳細は、別紙に参考資料として添付いたします。


Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

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

メールマガジン登録

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