‘社内マニュアル’ タグのついている投稿

【わかりやすいマニュアルの作り方】第208回 取扱外注のコストとパフォーマンス

2013年12月4日 水曜日

弊社は取扱説明書を制作する「取説屋」です。そのため、といっては何ですが、コストはとても大切です。弊社ではページ数千~一万といった金額を提示していますが、さて、これを外注ではなく社内でやればコストは抑えられるから、という意見は何度か承ったことがありますが、さていかがでしょうか。

■取扱説明書のコスト

先日某所で、雑談として話していたのですが、A4 / 50-60 Page程度の取扱説明書を作成することになった場合に「メーカーの社内で制作したら、いくらくらいかかるものでしょうか?」という話をしました。

そうしたら…軽い気持ちで聞いたこちらが驚くような回答が返ってきました。
「うーん、だいたい百万ですかね」
え? ひ、ひゃくまん?聞き違いかと思いました。その金額!どう考えても、うちで作った場合の二倍近い金額になるではないですか。
「TOPエンジニアが、二人ぐらい一ヶ月近く拘束されるんですよ。それくらいのコストにはなりますよ。」
「開発エンジニアが拘束されるのが嫌な場合には派遣の人を入れますけれども、やはり二ヶ月半ぐらいは頼むことになります。」
これらのコストを計算してみると確かに百万近くなると言うのは間違いが無いところです。別に無理に足し算したと言うことも全くありません。

■できた取扱説明書のパフォーマンス

では、そうしてでき上がった取扱説明書の性能はどのようなものでしょうか。

自分が「取説屋」という職業をやっているから言うわけではありませんが、日本においては、一般人向けの技術的ドキュメンテーション教育は一切行われていません。簡単に言い直すと「取説の作り方は何処でも指導しているところなんか無い」と言うことなのです。これを知ったときは、大変なショックでした。
自分はソフトウェアの開発をやり、出版業界の先輩方に取扱説明書と必勝本(ハンドブックとデータブック)の執筆と編集を学びました。そこで、取扱説明書の内容として書かれる技術と、編集の技術の両方を学ぶことができました。
読者の想定方法なども、このあたりで学んだことです。

したがって、技術的に優秀なエンジニアさんが手がけた場合でも、彼らは、編集やライティングについては、全くトレーニングを受けていません。したがって内容に間違いが無く、技術的にしっかりした内容であっても、一般ユーザーにとっては読みにくいものができあがる可能性がとても高いのです。これは社内のエンジニアさんに限りません。当然派遣の人も同様にトレーニングを受けていないはずです。つまり、あるレベル以上の取扱説明書は、作ることができたとしても、それは「個人の能力」によるもので、安定的に供給することは難しいと言うことを意味します。
私は他社の制作した取扱説明書を貶めたい思っているのではありません。単純に取扱説明書の作り方をトレーニングしてるところが「ない」と説明しているだけなのです。

この件については、次回もつづけたいと思います。

 


【わかりやすいマニュアルの作り方】第186回 取扱説明書制作の実際について

2012年10月16日 火曜日

10月に入ってからさすがに涼しくなってきました。
城南島海浜公園まで、うちのミニバイクでツーリングにいったりしたのですが、8月~9月の立っているだけでフライパンの上で焼かれているような感覚は味わわずにすみました。
もっとも、潮風は強く吹いていましたが、それはわざわざそういうところに行ったのですから文句を言える筋合いではありませんね。
しかし、我ながら出航していく船を見て「ああ、あれは伊豆諸島行きだな」とかわかるようになっているのはすこしマニアに踏み込みかけている気がしました。
でも、伊豆諸島は良いところなんですよ。
…さて。

 

■業務マニュアルを作ったことがある人の話

取扱説明書を作って見たことのある人と話をしました。
いろいろと面白い話をしたのですが、「取扱説明書のようなものは、現代ではワードもエクセルもパワーポイントもあるしで、簡単に作れる」ように思われているという話から始まりました。
では、実際はどうだったかということを聞くと、実に興味深い話を聞くことができました。実際は大違いなのですね。
何よりも、実際に書いてみると、ぜんぜんボリュームが足りない。出来たものは、まるでメモ、マニュアルとしてはとても不完全なモノになってしまった。
書き方については、教えてくれる人がいるわけでもないし、OJT でやれと言われる。
以前の担当者が作った不完全なものがあるけれども直せない。
やろうとしたが、なによりも書かなければならないボリュームに挫折することになった。
書かなければならない内容で、細かいことが抜けている。
たとえば、郵便物は午前/午後の2回持っていくと書いてあるが、実際にはもっとこまめに持っていくのだが、それを書き直して良いのかどうかわからないので、直せない。
誰でも出来ると思われているから、コストをかけられない。分かりやすく書く方法を教えてくれる人もいない。
長文の書き方や、セクション分けについても、アウトライン機能や見出しのコントロール方法も機能としては存在するけれども誰も教えてくれる人もいない。

以上のように、取扱説明書の制作なんて簡単と思われている状態と、実際のギャップという話をたくさん聞くことができました。

■ポリシーは?

実務の問題点については、まぁどこにでもあることでもありますし、いくらでも書くことができますが、そのいくつかは正しい教育をしたり、きちんとかけるべきところにコストをかければ、問題は解決できることが多かったりするので、全部を書き記すことはしません。

しかし、その根本にあるところだけは一言書いておかなければなりません。

「業務マニュアル」って誰のために作るものですか?

当サイトでいつも扱っている商品に添付する取扱説明書は基本的に「お客様」のためです。PL法対策などはいかに大切なことであっても、その一部だしかありません

でも、業務マニュアルの場合、いったい誰のために作らなければならないのか、根本的なポリシーがはっきりしていない場合があるのです…もちろん全部ではありませんが。

しかし、そうした場合、まず「何のために」「誰のために」作るのかといったポリシーをしっかりしないと小手先の技術的な改良ではどうにもならないということにもなりかねません。

まず、ポリシーをしっかりすることです。

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


【わかりやすいマニュアルの作り方】第166回趣味の取扱説明書作成

2012年4月17日 火曜日

本当に温かくなりました。
先日まではオートバイでちょっと出かけようと思ったらオーバーパンツを履かなければならなかったところが、今ではすっかりGパン一枚で出掛けられるようになりました。
少し残念なことに桜も散り始めてしまいましたが、その代わりといっては、なんですがいろいろな花が咲き始めています。

■趣味の取扱説明書作成

今回はちょっと変わったことを書きます。
いつも、弊社では業務として取扱説明書を作成しています。
ですが同時に、私自身は古くからのパソコンマニアであり、新しいソフトなどが、大好きなのです。

先日、私は新しくアンドロイド携帯を入手しました。
まぁ、いまごろという感じではありますが、もちろん業務でアンドロイドのソフトウエアの取扱説明書を作成するということもありますが、それ以上にモバイルギアやW-Zero3などを買っていたPDAマニアの血が騒いだというのが正直なところです。

さて、そのスマートフォンのあるアプリの使い方を探したのですが見つけることができませんでした。
そのアプリはもともと外国で作成されたものです。といっても書かれているのは英文なのでヘルプを読むことはそう難しくなくできました。
英文を文字起こしして、翻訳すればいいのです。英文に慣れている人なら、なんということもないほどの作業です。実際、三十分程度の作業でした。
翻訳するのが得意でないならば、Google翻訳などを使っても構いません。べつに、クライアントがいて、用語の定義について詳しくチェックされるわけではありませんから。

■テクニカルライティングと編集

さて、ではその翻訳した結果をそのまま取扱説明書として使えるかというと…
実はまったく使えません。

今回翻訳までは本当に短い時間でできました。
しかし、その後にできあがったテキストを「手順の説明」として、レイアウトして、取扱説明書として読めるような文章にリライトするのに同じだけ、もしくはそれ以上の時間がかかりました。

ではどうして、レイアウトとリライトに時間がかかるのでしょうか。
答えは掲載されているメディアの違いと、文化の違いの2つです。
レイアウトを変更しなければならないのは、スマートフォンの画面上のポップアップメッセージをブログで読めるようなテキストの形に変えなければならないことが理由です。
印刷物の方が、よりきちんとレイアウトされた形にはなっていますが、ブログでもある程度きちんとしたレイアウトを組まないと、読みにくくなります。
英文と日本語が混在していたら、読者は読む気をなくします。
読んでもらえないと、そもそも書いた意味がありません。読んでもらうためにはきちんとレイアウトをする必要があるのです。

■文化の違いとは

それでは文化の違いというのはどういうことでしょうか。
画面上の英文と、空を説明する日本語では、全く構造が違います。
最も簡単な例を挙げてみます。
英文 : “Press OK , and start download”
直訳 : OKを押すと、ダウンロードが始まります。

これでも意味は通じます。社内向けの文書ならそれでいいかもしれません。
ですが、取扱説明書の文章だと以下のようになります。

翻訳 : 「OK」ボタンをタップすると、ダウンロードを開始します。

どうして文章がこのように変化するかについては、「取説屋」の秘伝ノウハウ部分でもありますから詳しくは説明しませんが、「ボタンを操作する人」と「ダウンロードを行うマシン」の2つの主語がまぎらわしくならないような日本語にする必要がある、ということだけは書いておきます。
さらに、翻訳だけではどうにも寂しいとして、先頭に手順のまとめを描き加えたりしました。
こういった処理をほどこしていたら、軽く考えていた趣味の取扱説明書制作が以外と手間を食ってしまったのでした。

まぁ、今回は半分趣味の話ですが、弊社・取説屋はどんな仕事をするのかというサンプルを見たい人は、以下をごらんください。

MapDrpodの地図データ ダウンロードの方法 覚え書き

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


【わかりやすいマニュアルの作り方】第159回取扱説明書の対象について

2012年2月14日 火曜日

ようやく少しずつ温かみを感じるようになってきました。
まだ春は遠いですが、春の足音が聞こえてくるような気がします。

弊社では、先週はいろいろな所に出かけていました。
今回は、その中でつかんだ新しい考えについて述べさせてもらおうと思います。

■制作する取扱説明書の対象を広げる

弊社では、これまでは主に「一般消費者」(コンシューマー)向けの取扱説明書を扱ってきました。

したがって、制作された結果は「印刷所に納品するとそのまま印刷できる」データであり、「凝ったレイアウトされたキレイなデザイン」の仕上がりでした。

はっきり言うと、格好の良い出来あがりです。

しかし、問題もあります。

格好良くしようとすると当然ながらコストがかかります。分かりやすくするためにはある程度の作業コストは必要ですが、格好良くするためのコストとは別のことです。

簡単に言うと、コストの半分はDTPとデザインとレイアウトに掛かっています。これを切ってしまおうということです。

実を言うと、弊社の利益もこのあたりから捻出させていただいたりすることもあるので、これは経営的にはかなりの冒険でもあるのですが…。それでも、この仕事には絶対に意味があると私自身が確信しています。だから、やるのです。

■技術者・作業者・販売者向けの取扱説明書

最終消費者向けの製品を作っていないメーカーやサービスを提供している会社は非常に数多くあります。実際のところ、最終消費者向けでないメーカーやサービスを提供している会社の方が数が多いのではないかと考えています。

営業に行くとよく言われるセリフがあります。

「うちでは消費者向けの製品は作っていないから、取扱説明書は必要ないんですよ」

そうでしょうか。

自分は「技術者・作業者・販売者向けの取扱説明書」のできが、いまひとつのために、作業が滞ったり問い合わせが多くなったりしている例を数多く見ています。

作業マニュアルはきちっと作られている方が良いに決まっています。あえて言えばきちっとできていない作業マニュアルはタダのゴミです。

自分はきちんとした取扱説明書を作成する技術を持っています。それは構成であったり、編集であったり、、最低限のレイアウトの知識であったりしますが、それは極小のハンダ付けをしたり、バフがけで平面に磨いたりすることと同じように、身につけようとするとどうしても時間がかかるものです。

極小のハンダ付けをしたり、バフがけで平面に磨いたりする作業が必要になったらどうしますか?社内の事務員にやらせたり、エンジニアさんにちょっと練習させてやらせますか?
まさか。当然、外注しますね。

取扱説明書制作も一緒です。「きちんとしたわかりやすい取扱説明書」を制作するには、技術が必要です。

「技術者・作業者・販売者向けの取扱説明書」をわかりやすく作り直して、公開してみませんか?

弊社では、現在「技術者・作業者・販売者向けの取扱説明書」の価格体系や作り方を検討しています。少なくとも現状の最終消費者向けの取扱説明書に比べれば大幅に低コストでできると思われます。

もちろん、コストを削っただけではなく、お使いになるお客様にもメリットがある方式、具体的には最終的に納品するデータがDTP用のIllustratorやIndesignといった、操作に専門的な知識が必要なデータではなく、一般的なWordのデータと公開用のPDFのセットなどにする(その分は弊社でもDTP作業がなくなってコストが低下します)といったことを考えております。

詳しく仕様が決まったらまた、こちらでお知らせさせていただきます。

よろしくお願いします。

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


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

2011年12月27日 火曜日

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

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

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

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

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

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

■デザインの要件

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


【わかりやすいマニュアルの作り方】 第32回  Microsoft Wordで社内マニュアルを見やすくするには 3

2009年3月10日 火曜日

●文字レイアウト

元のワープロ文書のレイアウトを見やすくするために、次のような工夫をしています。

レベルによって見出しに差を付ける

元文書では見出しと本文の違いが小さく、見出しが余り目立ちませんでした。
また、大見出しと中見出しも違いが少なく、見出しのレベルを誤解したりするおそれがありました。
そこで、大見出しを反転としたり、フォントを変えて、本文と文字サイズであきらかな違いを付けるなど、見出しをわかりやすくしました。

本文の文字サイズと行間・字下げ

本文の文字サイズが必要以上に大きかったのを小さくし、行間も空きすぎていたのを直しました。
また、本文を見出しにくらべて字下げすることで、1行の文字数を多すぎないようにコントロールし、同時に見出しを目立たせるようにしています。

ヘッダやフッタを活用する

ヘッダに文書のタイトルとページ数/総ページ数を入れています。
こういったスタイル指定した文書をテンプレートとして利用しています。

リスト

メモする内容について、本文内に列挙されていたものをリストに直しました。


【わかりやすいマニュアルの作り方】 第31回  Microsoft Wordで社内マニュアルを見やすくするには 2

2009年3月4日 水曜日

前回の続きです。

■見やすさのポイント

同じ内容の文書でも、見せ方が違うだけでこれだけ「わかりやすさ」が違ってきます。
ここでは弊社が前のページの元の文書(左)を修正するときに注意したポイントについて説明します。

●テキスト(文章)

「内容を簡潔に示した見出し」と「見出しに対応した本文」を簡潔に書きます。
本文の書き方

「見出し」の直後にはその項目の概要を書き、詳細に進むというように、内容を把握しやすくするように住めています。
また、元の文章は3つ見出しだけが続いて、本文がその後に続くといった部分があるため、それぞれを見出しに対応するように文章を分割しています。

「見出し」の付け方

「○○機能」のような体言止めと、「○○しましょう」といった動作を主体とした書き方の2種類を混ぜて使うことがないようにします。


【わかりやすいマニュアルの作り方】 第30回  Microsoft Wordで社内マニュアルを見やすくするには 1

2009年2月24日 火曜日

前回まで同じネタが続いて、書く方も飽きてきたので、今回からしばらく趣向を変えた話をしてみようと思います。
さて、今回は画像でWordの業務マニュアルのサンプルです。

電話応対マニュアル原文

電話応対マニュアル原文

電話応対マニュアルリライト済み

電話応対マニュアルリライト済み

ほとんどの方が最初の文書のようなものを作っていらっしゃるのではないでしょうか。

今回は、これがどうやると下のようになるのかの説明をします。上の文書から下の文書にするには、ちょっとしたコツとルールを覚えるだけです。
いつでも誰でも見やすいレイアウトの文書が常に自動的に作れるようになります。

文字組について

というわけで、最初の一回は「文字組」についてです。
見やすさの秘密は「文字組」を変えたことにあるからです。
次回から詳細について説明します。