連載
» 2010年12月13日 00時00分 公開

誰にでも分かるSEのための文章術(15):システム開発を成功させたいSEに送る、「文書執筆のおきて」まとめ (1/2)

「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。

[谷口功,@IT]

 文書を記述するに当たって、常に意識しておかなければならない点が4つあります。

  1. システム開発における文書の重要性を認識する
  2. 読み手のことを考える
  3. 文書の構成を作ってから、文書作成に取り掛かる
  4. 必ず読み返す

 これらは、分かりやすい文書を作成するための基本ポリシー、“おきて”とでもいうべきものです。連載の最終回となる今回は、文書作成時に常に意識しておきたい「文書執筆のおきて4カ条」について解説します。

その1:システム開発における文書の重要性を認識する

文書の重要性を認識せずして、質の高い文書は作成できない

 システム開発において、文書は非常に重要です。この点を認識することが出発点です。文書の重要性を認識することなしに、分かりやすい文書は作成できません。文書を特に重要だと考えず「作成しないといけないから、取りあえず作成する」と思っていると、書き上げた文書はおのずと粗雑になり、分かりにくいものになってしまいます。

なぜ、システム開発にとって文書は重要?

 では、システム開発において文書が重要だとして、なぜ重要なのでしょうか。それは、文書が顧客とのコミュニケーションの中核となるツールだからです。情報や主張を顧客に伝えるに当たって、体系的かつ総合的、そして公式に伝達できるコミュニケーション手段は文書だけです。

 もちろん、顧客とのコミュニケーション手段は、文書以外にもさまざまあります。

  • 電話での通話
  • 打ち合わせでの会話
  • メールのやりとり

 ですが、これらは補助的、補完的なコミュニケーション手段です。電話や日々のメールは、情報や主張の断片的なやりとりで、体系的ではありません。打ち合わせで交わす会話も断片的なものであり、打ち合わせそのものは整理されていない情報の集積です。

 一方、文書は体系的な情報や整理された主張を、公式に顧客に伝えることが可能なコミュニケーション手段です。もちろん、メールを使ってきちんとした情報や主張を顧客に伝達することもありますが、こうしたものは文書の範疇(はんちゅう)に含まれるでしょう。

 文書が分かりにくいと、顧客とのコミュニケーション不全につながります。コミュニケーションがうまくいかなければ、情報や主張が顧客にきちんと伝わりません。結果として、システム開発はうまく進まないでしょう。

 システム開発を成功させたいと思うなら、エンジニアは文書の重要性をしっかりと認識しておかなくてはなりません。

その2:読み手のことを考える

読み手のことを考えない文書は、伝えることを放棄した文書

 分かりやすい文書にするためには、常に“読み手のことを考える”意識を持ちながら記述しなければなりません。

 文書のように、何らかの事柄を伝えたいときには、必ず読み手のことを考慮して表現しましょう。これは原則中の原則です。読み手のことを考えないで表現することは「伝えることを放棄したに等しい」といっても過言ではありません。

読み手のことを考えるとは、どういうことか?

 では、読み手のことを考えるとはどういうことなのでしょうか? 一言でいえば、

  • 読み手の立場に立って、読み手の視線を持つ
  • その上で、語句や文章表現、文書の構成などが理解できるかどうかを、検証しながら記述を進める

ということになります。読み手のことを考えなければならないのは、文書が、基本的に送り手から受け手への「一方向コミュニケーション」だからです。対話のように双方向コミュニケーションでは、聞き手は分からない点があればその場で聞き返して確認できます。しかし、文書によるコミュニケーションでは、そのようなやりとりができません。

 そこで、書き手は自分の中で読み手を想定して、読み手と架空のやりとりをしながら文書を書いていきます。記述した文書が分かりやすいかどうかを、読み手の視線で検討・確認しながら記述を進めるわけです。

読み手について知ることが大事

 なお、読み手のことを考えるためには、読み手のことを知らなければなりません。そのためには、

  • 想定する読み手の技術的な知識
  • 属する業務分野や役職
  • 文書に求めるもの・期待するもの
  • 文書の読み方

などを把握する必要があります。これらの要素を基にして、文書を分かりやすくするにはどうすればよいかを考えましょう。それが、「読み手のことを考える」ということです。

       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

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

メールマガジン登録

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