Shoeisha Technology Media

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

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

テーマ別に探す

ほんのすこし書き方に注意すれば、あなたのドキュメントはさらに分かりやすくなる!

  2009/01/27 09:00

マニュアルには、タイトル、概要、説明手順、補足情報といった要素が必要です。そして、各要素には、それぞれ分かりやすく書くコツがあります。今回は、マニュアルを構成する各要素の上手な書き方を紹介します。【バックナンバーもどうぞ!

パーツ(部品)ごとに書き方があります

 マニュアルライティング講座の第1回目では、マニュアルを書き始める前に「文書の設計図である構成案」を作ることの大切さをお伝えしました。マニュアルのような構造化された文書を作るには、全体像を示す設計図が必須です。逆に言えば、設計図ができれば、わかりやすく伝える第一段階はクリアしたようなもの。

 今回は第2段階として、各ページの中のパーツ(部品)をわかりやすく書いていくためのポイントを説明していきましょう。突然ですが、お弁当の定番「幕の内弁当」をイメージしてみてください。幕の内弁当には、たいてい煮物、焼き物(魚など)、卵焼き、漬け物が、ご飯とともに詰められていますよね。これらがないと、幕の内弁当らしくなりません。

 ユーザーマニュアルにも、入れるべき要素があります。タイトル(見出し)、概要、説明手順、補足情報などです。日頃使っているケータイやデジカメの取説もソフトウェアのマニュアルも、そのような構成要素から成り立っているはずです。これらの構成要素であるパーツをきちんと揃えること。これが大切です。

 そして、各パーツには、わかりやすく書くためのコツがあります。そのコツを知れば、わかりやすさが向上します。どれも同じように書けば良いというのではないのが肝。素材ごとに、調理方法や味付けが違うからこそ、お弁当のおかずは美味しくなります。パーツごとのライティングの基本を押さえていきましょう。

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


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


著者プロフィール

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

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

バックナンバー

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