Shoeisha Technology Media

EnterpriseZine(エンタープライズジン)

EnterpriseZine(エンタープライズジン)

テーマ別に探す

ちょっとした構成案を作れば、あなたのドキュメントはもっとわかりやすくなる!

2008/12/24 09:00

システムの開発において、ドキュメントの作成は避けて通れません。一方で、文書の書き方についてキチンと習ったよ、という方は案外少ないのではないでしょうか。どうせなら、読み手に「わかりやすい!」と言ってもらえるドキュメントを書きたいですよね。この連載では、マニュアルライティングの基本中の基本を解説していきます。

わかりにくい手順書・マニュアルが仕事を増やしていませんか?

 システムが稼働し始め、初期のトラブルもつぶしたにも関わらず、何故か問い合わせは終わらない状況が続く。今日もお客様からせっぱ詰まった様子の電話が…。

  「月末処理をしていて、

   仮に入れた数値をすぐに変更したいんですが、できないんです。

   何とかしてください」

 「それなら、こうすればできますよ。まずメニューの…」と、手順を説明したところ、どうやらうまくいった様子です。「手順書にだってちゃんと書いておいたし、難しい操作でもないのに。おかしいなぁ」「ちゃんと読んでから、操作して欲しいよ」なんて思っていませんか?

 このような状態は、わかりにくい手順書やマニュアルが引き起こしている場合が、しばしばあるのです。手順書やマニュアルに「書いてあるつもり」「わかるように説明しているつもり」であっても、読み手であるお客様にとっては「必要なことが書かれていない…」「わかりづらくて操作ができない…」と受け取られていたら、問い合わせがくるのは当たり前。

 また、情報が不足していたり、誤解を招く書き方をしていたら、お客様から問い合わせがきたり、トラブルを引き起こすのも、当然と言えば当然です。

  「もっとちゃんと書いておいてくれれば、こんなトラブルはなかったのに…」

 これではお客様から信頼を得ることはできません。

cap

わかりやすいマニュアルはシステムの価値を高める

 「システムの良さ、技術力では負けないのに、他社と比べて提案力やサポートが弱いと言われてしまう…」このような状況も、ドキュメント(文書)のわかりづらさが原因となっていることがあるようです。

 システムやソフトウェアという形がないものを、相手に説明し、提案し、使いこなしてもらうために、提案書や要件定義書やマニュアルがあります。ですから、それらのドキュメントがわかりやすくできていなかったとしたら、システムやソフトウェアの良さをお客様に十分理解していただけてはいないことになります。

 「使ってみればわかる」では、ダメなのです。その良さを十分に理解してもらい、さらに活用してもらうための的確な情報を提供すること。それがドキュメントの役割です。良いドキュメントは、競争力を高めます。わかりやすいドキュメントでシステムの価値を高め、技術力をしっかりお客様に伝えるよう、発想の転換をしてください。

※この続きは、会員の方のみお読みいただけます(登録無料)。


著者プロフィール

  • 高橋 慈子(タカハシ シゲコ)

    テクニカルライター。テクニカルコミュニケーションの専門会社 株式会社ハーティネス 代表取締役。マニュアル制作や改善に携わるほか、わかりやすく書く技術を盛りこんだ企業研修なども行っている。

バックナンバー

連載:ドキュメント力を強化したい人のためのマニュアルライティング入門講座
All contents copyright © 2007-2017 Shoeisha Co., Ltd. All rights reserved. ver.1.5