「取説屋:石井ライティング事務所」の代表兼テクニカルライターのブログ 本家サイト http://torisetuya.com

【わかりやすいマニュアルの作り方】第157回取扱説明書は公開しよう

寒いですね。

いまが一番寒い時期ですから仕方ないですが、それにしても雪がなかなかとけません。
うちではバイクを使っているのですが、結構広い範囲の駐車場の雪が溶けずにそのまま凍り、出口がふさがれてしまいました。
雪がなくなって安全にバイクを出せるようになるまで、ほぼ一週間かかりました。

■取扱説明書はどんなときに使う?

今回は取扱説明書の公開についての話です。
ちなみに、メーカーさんで取扱説明書を制作している場合を想定しています。

さて、まず根本的な話から。
取扱説明書はどんな時に使いますか?
そうです。買った直後と、しばらく使っていて使い方がわからなくなったり、トラブルが起きたときですね。
購入直後は公開していても、あまり見ることはないでしょう。なぜなら紙で印刷された取扱説明書が手元にあるからです。
では、2年くらい使用した後に使い方がわからないことが出てきたらどうでしょうか。

たしかに、取扱説明書には「この取扱説明書はいつでも参照できるように大切に保管して下さい」と書いてあります。自分もそう書いています。
ですが、実際にはどうでしょうか。
「速攻で取扱説明書は捨ててしまう」という人はさすがに少数派だとしても、「外箱の中に入れっぱなしで押し入れのどこかにしまった」「どこにあるか忘れた」といった人がかなりの割合を占めるのではないでしょうか。
あ、これは決して自分の体験談ではありません。ただの一例です。念のため。

こうしたときに、Webで公開してあれば、少なくとも検索できるユーザーは見つけることができます。
また、トラブルの場合にしてもたとえば「停電によって時計がリセットされて12:00になってしまった」「電池の交換方法が分からない」程度のこと、リセットしたり再設定したりすればすむことであれば、ユーザーが自分で時計を再設定すればすみます。うまくいくと、ユーザーサポートにかかってくる電話がわずかではあるかもしれませんが、減るかもしれのせん。
もっとも、減ったとしても「かけるのを止めた」件数は調査する方法がないので、どれだけ減ったのかは定量化した調査は難しいと思いますが。

■公開した取扱説明書のもうひとつの使い道

実は、公開した取扱説明書の使い道はもうひとつあります。
「買う前に取扱説明書を見てみる」ということです。
少なくとも、自分と他の知り合いも何人かしています。
宣伝は基本的によいことしか書いてないということは前回書きました。それに対して、取扱説明書には製品に関するすべてのことが書いてあります。
メンテナンスや清掃の方法、消耗部品がある場合(フィルター、ボンベ、電池など)は交換方法と消耗部品の価格や消耗部品の寿命、こんなことは取扱説明書にしか書いてありません。
家電製品の場合、こういった情報は使い勝手に大いに影響します。しかし、広告からはこういった情報を得られるとは限りません。もちろん、店頭に行ってその商品を直接さわり、店員さんに聞けば教えてくれるでしょうが、そうすると、そこで何かを買わなければ悪いような気になってしまいます。
Webで調べようと思ったら、その製品をすでに買った人のユーザーレポートを探すしかなく、見つかる保証はありません。
ですから、自分は買う前に取扱説明書を参照できる方がありがたいです。

そして、もうひとつ。
これは自分がこういった仕事をしているからこその感じ方かもしれませんが、取扱説明書を公開しているメーカーの方が信頼がおけるような…気がします。
第一には、ユーザーサポートをやる気があるかどうかが透けて見えるということ。
もう一つは、取扱説明書には「良いことも悪いことも含めて」書いてありますから、そういうことも含めて公開しても使う人の利便性を優先する会社だと考えられることです。

以上の理由から、弊社としては取扱説明書はできだけWebにて公開(パスワードなど付けない)することをお奨めします。

もちろん、弊社では紙の取扱説明書と同時に公開できる形式のPDFも同時に提供させていただいております。と、宣伝をさせていただいたところで、今週はここまでに。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第155回エディトリアルデザインの話

もう年末です。
あっという間に、年の終わりが来てしまいました。このブログも細々ながら155回、読んでいただいている方には、感謝にたえません、また来年もよろしくお願いします。

さすがに、新年の更新はお休みさせて頂きます。

■エディトリアルデザインの話

今回は取扱説明書のデザインの話です。
取扱説明書のデザインと、広告・宣伝・広報のデザインは目的が違います。
したがって、同じ考えで作ってはいけません。

デザインというと、目立つもの、綺麗なもの、かっこいいものを作ることがイメージされますが、デザインは目的にしたがって作られるものです。
自分は基本的に製品の特性を調べ、それを記述すること・説明することを本業としている「テクニカルライター」であり、デザイナーではありません。
実際のところ、カッコいいものを作りたければ、躊躇無くデザイナーに依頼しますし、その方が良い結果が得られることは分かっています。
しかし、文章全体を構成する編集という技術の中には、文章全体の論理的な構成を作成し、それを見やすいように並べるといった技術も含まれています。エディトリアルデザインというものです。
さてそこで考えることですが、見やすいとキレイというのは必ずしも同じではないということです。もちろん、優秀なデザイナーがデザインすると両方を満足することは可能ですが、一般的なデザインを業務としていない素人の社員が行った場合を考えています。

自分がデザインの教育を受けたわけではありませんが、ソフトウェアの必勝本などを作った実務経験から指定紙の書き方などを実務で覚えさせられました。

■デザインの要件

では、エディトリアルデザインで要求される内容の簡単な例をあげてみます。

  • 内容が論理的なブロックで分かれるところは、視覚的にもブロックとして認識できるように、分けるのが望ましい
  • 説明本体の流れとは別だが、その場所に置いておいた方が良い説明はコラム形式にして近くに置く。

難しいことではないと思います。むしろここを読んでいらっしゃる方としては「なんだごく普通のことじゃないか。」と思われるかもしれません。そうです、それで正しいのです。

ですが、実際に業務マニュアルを作成しようとすると、ソフトに準備された機能に引きずられてしまうということがよくあります。

特にMicrosoftWordなどを使って政策をしていると、意識的に避けようとしていない限り「ぎっちぎち」に詰めたものを作ってしまう傾向があります。
ソフトウェアがもともとビジネス文書を作成するためにできているので、一般ユーザー向けの文書を作成するときは、いくつかの設定を変更しなければならないのですが、そんなやり方はどこにも書いてありません。

上の要件を満たすための見出しの作り方や、コラムの作り方は機能としてはWordの中に用意されています。しかし、それは使い方を知っていないとそこにアクセスすることはできません。

たとえば、人が一目で見ることができる1行の文字数はどれだけか、1行の行間はどの程度にするのが適正かといったことは制作を始める前に知っておくべきことです。
そしてそのために、ページ数が多くなったり、思ったより改ページが多くなって白っぽい取扱説明書になったからといって、きっちりと詰めた文書にすべきではありません。

優先すべきなのは使う人にとっての、読みやすさなのです。

前にも書きましたが取扱説明書は、製品を扱うために必要な「お客様に説明する」部品です。
部品であれば「使いやすく作る」のは当然だと思うでしょう。取扱説明書も使いやすくなければならないのです。

色を使わないとダサく思うかもしれません。

見出しがデカくてバカみたいだと思うかもしれません。しかし、人間にはある程度以上の差がないと見出しと本文を見分けることは難しかったりするのです。

1ページの情報量が少ないと思うかもしれません。

こういったことを上司から言われるかもしれませんが、それでも取扱説明書はお客様のために作っているということを忘れないでください。

少なくとも弊社ではそう考えて取扱説明書を制作しております。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第132回 注意書きの作り方

今回は注意書きの作り方について説明します。

取扱説明書は、一般にその製品の、正しい使い方と「使ってはいけない使い方」について説明します。

ここまで説明してきた内容ではほとんどが「正しい使い方」の書き方について説明してきました。
しかし、正しく扱っていても刃の部分に手を当てると危険なものや。熱くなるものは数多く存在します。
これらの製品は、決して欠陥製品ではありません。正しくは使えば怪我をしない。
間違った方法で取り扱えば怪我をする。当然のことです。

それだけに、やってはいけないことについても、はっきりと書くことが、必要になります。

■普段とは逆のことを考える

以前にテストの項目で書きましたが、禁止事項(危険なこと)および注意書きについては、自分の経験と想像力がものをいいます。

正しい手順を確認するのにも、技術的な素養が必要です。

しかし、「正しくないこと」を明記しこれをやってはいけないと書くためには、その正しくないことを想像する能力が、必要になってくるのです。

そのためにはどのように考えたらよいかを紹介します。

■やってはいけないことを調べる

一番簡単なのは、やってはいけないことを調べることです。

既存の取扱説明書の注意書きや、過去に書いたものを流用するといったことが代表的でしょう。

しかし残念なことに、この方法は今まで自分のやったことのないジャンルのものには使えないという問題があります。

次に、メーカーの人や販売の人に、今まで何か問題がなかったか、を聞いてみる、という方法があります。

これは、優れた方法です。
メーカーでは、かなりの部分のトラブルについて把握しています、したがって問題点についてもわかっている場合が多いです。しかし残念ながら、メーカーとしてはそれはまさしくやってほしくないことのため、情報が止まってしまう場合があります。
特に実際に事故になった事件などについては、メーカー担当者さんの口が重くなる傾向が高いです。まあこれはやむを得ないことですね。

では、「やってはいけないこと」というのはどのようにしたら、調べられるでしょうか。

簡単なのは「商品名」+「事故」や「トラブル」としてウェブで検索することです。
ただ、これはあまり効率がよい方法ではありません。有名な事件があれば何度も重複して出てきますし、小さくてすんだ事故については検索にかからない場合があるからです。

実は、筆者のお薦めとしては、公的機関が公開している「事故情報データベース」にあたってみることです。
NITEはもちろん、各種の団体が数多くの事故情報を公開しています。
これらのデータベースで、「商品名」で検索をかければ、かなりの数の事故情報が出てきます。

ここで表示された事故情報に目を通すと、事故の原因に幾つか共通するものが見えてきます。
たとえば、熱くなる機器であれば、不注意で触ってしまった、子どもが触った、ちょっとした時に席を外したら出火したといった具合に、同じような傾向が見えてきます。

ここまでがやってはいけないことに関する、事前調査です。

これを基に、実際の製品と合わせて注意書きを作成していくといった手順になります。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第129回 工夫の余地

ようやく暖かくなってきたなと思ったら、春の嵐です。
この時期になると毎年流れるあの歌ですが、今年はとても残念なことになってしまいました。

■手順の説明

さて。
今回も前回の説明図を使用して、説明します。

この機器が、メモリカードをセットしたあとにスイッチを押すものとします。

普通に描くと、以下のようになります。

矢印説明図3

イマイチ格好悪いですね。

しかし、手順の番号をテキストとして入れたりすると、その説明の分だけ画面のスペースがとられてしまうのも事実です。

「このままでいい」という考え方もできます。
一応これで説明は全部入っています。ですから、説明としては責められることはありません。

ですが……「プロの取説屋」としてはこれでは納得がいきません。
こんなものでお金を頂くわけにはいかないと考えます。

ではどうしようか。ということで考え、工夫します。

■工夫の方法は無限

まず、この図が分かりにくいのはなぜかと考えました。

  • 矢印が全然目立っていない。
  • 手順の番号が見えない。

これではわかりにくいのは当然です。しかし、矢印を大きくするとテキストのスペースが圧迫されてしまうし、テキストを大きくしても効果は薄い……

そこで、いろいろ考えた結果として、できた解決方法が次の図です。

矢印説明図4

実際にはカードと矢印の位置関係なども少し調整していますが、基本的には矢印を大きくして、その中に画像として数字を入れ込むという方法を取りました。

逆に言えば「番号が入るだけ矢印を大きくした」とも言えます。

また、細かいことですが、1の番号は矢印の方向に合わせて斜めにするといった処理を加えています。これが、真っすぐだと大変な違和感を感じてしまうのです。

ここでは、サンプルを用いて描いているのであっさりとできたように見えますが、実際にはどうしようかという工夫を細かく積み重ねていったものです。

最後に、一番最初のイラストと、最終のイラストの比較図を掲載しておきます。
ただのイラストのようにみえても、実は細かいノウハウを詰め込んで、見やすくなるように工夫しているのです。

矢印比較図

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第128回 説明図のマーキング

余震が続きますね。早く収まることを望むばかりです。

さて。
今回は、説明図のマーキングについて書きます。
で、そのマーキングというのは何かということですが、前回の記事のこれです。

さて、もう一つのスイッチの方ですが、こちらには丸囲いがつけられています。

good_allow

上のスイッチのところですね。

■マーキングとは

マーキングとはマークをつけることです。前回の矢印もそうですし、丸を付けたり、★を付けたり色を付けるなんてことをする場合もあります。

もうひとつの丸囲いの使い方としては、ボタンの位置を示しその横に拡大上図をつけるといった使い方もできます。

こんな感じですね。

marker1

これくらい簡単なものであれば、通常の場合拡大などは必要ありませんが、図が複雑であればあるほど、こういった拡大図の使い方などはとても重要になってきます。

マニュアルを作る人間は、テキストの順番だけでなく、図でどう見せるかも同時に頭の中で考えなければいけないということです。
自分のような個人営業の場合、図をどのように見せるか考え、目的にあった写真を撮り、それを線画に起こし、矢印やマーカーを加え、見やすいように線の太さなどを調整します。

必要であれば図の中に吹き出しもつけますし、手順番号をつけることもあります。

全体のプロデュースと、見やすさの企画、これが取扱説明書の図の作り方の肝だと言えると思います。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第127回 説明図の矢印

東京でも桜が咲きました。
いろいろなことがありますが、季節は巡ってきます。やはり暖かくなってくるとうれしいものです。

さて。
今回は、説明図の矢印について書きます。

■説明図の矢印とは

以下の図は、製品にメモリカードをセットし、スイッチを押すところを示したものです。

なお、この製品は実際には存在しないものです。

no_allow

まぁ、ありがちの図ですね。
説明図としては、まあこれだけではわからないことはないのですが、普通はここにカードを入れ、このスイッチを押すといった矢印をつけます。
こんな感じですね。

bad_allow

これに引き出し先でスイッチおよびメモリカードスロットを書き加えればとりあえずできあがりといったところでしょうか。

多少わかりやすくなったとは思いますが、これでは、取説屋の商品としては失格です。

なぜかというと、カードスロットの位置やボタンの位置がわかるものの、どこをどうしたらいいのかちっとも分からないからです。

■矢印は説明図の補助

では、弊社であれば実際にどのように矢印をつけるか、実例で描いてみます。

good_allow

「なんだ、ちょっと太くしただけじゃないか」と思われるかもしれません。
まぁ、この程度であればそのとおりだ、とも言えるのですが…

カードの方は、カードの挿入位置と挿入方向を示しています。
そして、スロットの位置を目立つようにして、矢印のフチドリを白にすることで、製品本体と矢印がまぎれるのを防いでいます。
もちろんこれがカラー画像であれば、矢印だけを赤にするといったことも考えられます。

ちなみに余談ですが、こういった矢印は水平または垂直のものを作って、回転とシアーを組み合わせて斜めにして作成します。意外と流用が効かないので毎回作り直すことになっています。

さて、もう一つのスイッチの方ですが、こちらには丸囲いがつけられています。
これもある意味、説明のために注意を引くための、ツールです。
単純に矢印をつけるだけでなく、こういった工夫が必要になってくる場合もあります。

丸囲いをした場合、画面のほかの場所に拡大図をつけるといったこともできるわけです。

もうすこし、この話題は次回更新に続きます。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所


【わかりやすいマニュアルの作り方】第118回 読んでもらうには見掛けも重要 その1

年が明けてから、日増しに寒さが厳しくなってきます。
自分はちょっと駅から遠いところに住んでいるので、自転車やバイクで移動しているので余計に身にしみます。

■読んでもらわないと始まらない

さて。
今回からしばらくは取扱説明書の見掛け-ビジュアル-の話をしようと思います。

筆者は本業はライターで、デザイナーやイラストレーターでもないのですが、編集や作図については長年の業務の中で必要に応じてやってきました。
その中で、ひとつだけ断言できるのは「どんな内容を書いても、読みにくければ読んでもらえることはない」ということです。
どんなに良い内容でも、書き方が論文や訳書の報告書と同じだったりしたら、読み始める前にうんざりして放り出してしまうと思いませんか。

■最初は文字組の話から

筆者はライターなので、まずは自分の得意なテキスト作成の見栄えについてから入ることにしましょう。

たとえばこのブログですが、文字のブロックが詰まって真っ黒になるような書き方は避けています。

やっていることは以下の通りです。

  • 適当なところで改行する。
  • 必要に応じて段落を変える。
  • 見出しを入れる。

やっていることはこれだけですが、意識してやるかやらないかで見え方は大きく異なってきます。

漢字の比率などにも、ほぼ無意識にですが注意を払っています。漢字が多くなると、信頼性が高く見えるのですが、同時に難しいという印象を与えてしまいます。
このあたりをどうやって調整するかということは、正解はありません。
数をこなして、この媒体-メディアにはこれくらいということを掴むしか方法はないように思います。

また、こういったブログや掲示板といった1行の文字数をコントロールできない媒体以外では、行頭に1文字を残さないとか、ページ先頭に1行だけの段落を作らないといった細かい制御を必ず行っています。

こういったことが「読みやすい」テキストに、ひいては「読みやすい取扱説明書」につながっていくのです。

この話は次回の更新に続きます。


【わかりやすいマニュアルの作り方】 第61回 マニュアルの形 その06

台風一過。気持ちの良い天気になりました。

被害を受けられた方にはお見舞い申し上げます。

「マニュアルの形」の続きです。

前回、マニュアルは「困ったときに見る」ということを書きました。
しかし、そうなるとマニュアルの評価は必然的に低くなります。なぜなら、困った状態でしか見ないものですから、マニュアルを見る=困っているとなってしまうからです。

それでも解決できれば良いのですが、そのままユーザーサポートに電話となってしまいがちだったりもします。

FAQなどに関してはウェブのデータベースなどの方が向いていますので、こういったものへの誘導などもあると良い結果につながるでしょう。

■チェックシートをマニュアルにする

さて、今回の話は「チェックシートをマニュアルにする」です。

日次の作業のチェックなどには「チェックシート」がよく使われています。コピーして一週間分を記載したりします。
普通の「チェックシート」には項目名しか記載されていません。

たとえば 「タイヤ空気圧 □」といった感じです。
慣れた人にはこれで良いのですが、新人や配置転換で人が入ってきた場合には、だれかがついて作業を説明する必要があります。
これを、 「タイヤ空気圧 □ エアゲージで測定、前輪●kg /後輪●kg」と説明があれば、説明の必要性は大幅に減ります。

また、作業に慣れた人でも数値の確認など作業の効率が上がります。

そうです。

作業中に毎回参照するチェックシートをマニュアルにしてしまえばよいのです。場合によっては同じ面ではなく、裏面にマニュアル(作業手順)を印刷してもよいでしょう。

そうすると、作業者全員にマニュアルが行き渡りますし、思いこみによる独自の手順から発生するミスも減るということです。
今回はマニュアルをチェックシートの形にするという話でした。

続きます。


【わかりやすいマニュアルの作り方】 第59回 マニュアルの形 その04

前回はマニュアルのPDFのしおりについて書きました。

当然、しおりや目次は自動生成しています。場合によっては索引もそうです。
こういった機械的な作業は人間がやるべきではありませんし、機械がやった方が(最後に更新を忘れなければ)確実で間違いがありません。もちろん、そういったことにあわせて作業方法や手順を選んでおかないと仕事がうまく動かなくなります。

さて、今回の話の中心はこの件ではありません。

■レシピは料理のマニュアルです

マニュアルの形の続きです。
マニュアルというと、普通はあまり好まれません。
しかし、膨大なマニュアルを集めて、皆が読み、しかも高い評価を得ているサイトがあります。

もったいぶっても仕方がないのですが、要するにクックパッドを初めとした料理のレシピサイトや、パソコン関連のQ&Aサイトです。

これらのサイトと製品マニュアルは立ち位置(メーカーの立場のマニュアルとユーザー視点のレシピ)が違います。ですからそのままの比較はできませんが、あえて強引に比較すると、最大の違いは「検索できるか」につきます。

製品を購入して設置(セットアップ)するときは手順に従ってすすめます。
これは既存のマニュアルに向いています。
では、それ以外のときは?

と、ネタを振ったところで次回に続きます。


【わかりやすいマニュアルの作り方】 第58回 マニュアルの形 その03

前回、PDFのマニュアルの話をちらっとしたので、今回はその続きでも書いてみようかと思います。

いまは、各メーカーが取扱説明書をPDFで公開しています。
たいへん良いことです。

さて。

■マニュアルのPDFにはしおりが必須

PDFには「しおり」機能がついているのはご存じでしょうか。

しおり付きPDF

しおり付きPDF

この画面は本サイトに掲載しているサンプル原稿(架空のプリンタです)を開いたところです。しおりが表示されているのがわかると思います。

このしおりは、MicrosoftWordやPageMaker、InDesignを使用していれば、ほぼ自動的に作成されるものです。
「ほぼ」というのは、さすがに一部の微調整が必要になる場合があるからです。

実際、はじめてマニュアルを見るときはこれが表示されている方が親切だと僕は考えています。
しかし実際には、この「しおり」が存在しないPDFが数多くあります。
場合によっては、印刷用の目次すらない場合も。また、印刷用の目次から、該当のページにジャンプする機能を使っていない場合もあります。

これでは何のために電子化しているのかちっともわかりません。
配布が多少楽になる以上のメリットはないと断言して良いでしょう。

もちろん、しおりタブの内容は「見出し」から自動生成されるものですから、完全ではありません。
しかし、はじめて調べごとをするときには、それなりの助けとなることは間違いありません。

こんなところも、マニュアルの「形」なのです。
印刷物と同じ体裁にばかりしばられていると、ユーザーに便利な機能を提供できなくなってしまうことがあるかもしれません。

続きます。


良い製品に良い取説を提供します is powered by Wordpress | WordPress Themes