必要な情報や読みやすいは読者で違う!
わかりやすいマニュアルの内容は、読者によって違います。
テクニカルライティングをするときに欠かせないことです。
しかし、往々にして忘れていることでもあります(汗)。
IT関係のマニュアル、素人とITエンジニアでは全く違います。
素人の方に難しい専門用語を並べても理解できません。
逆にITエンジニアの方に、素人向けのやさしい内容では意味がありません。
また、余計に読みづらいものです。
事故防止のためにも、読者をしっかりと想定することが大切です。
むずかしいことをやさしく、
やさしいことをふかく、
ふかいことをおもしろく、
おもしろいことをまじめに、
まじめなことをゆかいに、
そしてゆかいなことはあくまでゆかいに(井上靖)
むずかしいことをやさしく、やさしいことをふかく、、、、
そのためにはライターは中途半端な知識ではなく、しっかりした知識が必要ですね。
ノーベル賞受賞の学者は誰にでもわかるように話をします。
科学の素人にも興味が湧くように話をします。
これは、100ではなく200以上の知識と経験を持つからできることです。
さすがにこの域は無理ですが、せめて100の知識を持ちたいものですね。
それがプロのテクニカルライターです!
PCやソフトウエアの本を見習いましょう!
タイトルにも工夫がされています。
誰を対象にしているかがわかるようになってます。
初級〇〇〇、中級〇〇〇、上級〇〇〇、世界一さやしい〇〇〇、誰でもカンタン〇〇〇
誰を対象にしているか、ハッキリしています。
初心者用の本では、専門用語には解説があります。
大きな文字、イメージイラストが多く使われています。
読む気にさせることに、配慮されています。
しかし、研究者や技術者が読む本は違います。
専門用語の解説は、必要ありません。
文字も小さく、イメージイラストではなく、技術図面が掲載されています。
いくつか例を挙げます。
例1:金属加工機械のマニュアル
金属加工機械も機種によって読者が異なります。
(1)シンプルな金属加工機械
- 未経験者や経験浅い機械オペレータが使うことが多い
- 機械の取扱いや金属加工技術を熟知していない
- 専門用語を知らないこともある
- オペレータは日常の点検は行うが、保守作業は専門の技術者が行う
⇓ だから配慮が必要です! - 取扱いを誤ると大怪我につながます。
わかりやすく注意事項を書く必要があります。 - 専門用語の解説の必要です。
- 日常点検はわかりやすいイラストで説明する必要があります。
知識経験が浅いオペレーターが使います!
(2)複合金属加工機械
- 機械の取扱いや金属加工技術を熟知してる熟練の機械オペレータが使う
プロ中のプロが使います。
⇓ だから配慮は浅くてもOK - 専門用語の解説は必要ありません。
- わかりやすいイラストも必要なく、技術図面で構いません。
- 安全に関しても知識経験があるので安心です。
書かなくてよいというわけではありませんが、、、、、
例2:一般家庭で使う製品
一般家庭で使う製品では、とても注意が必要です。
たとえばウオーターサーバーの場合です。
- 一般家庭で使う
- 主婦や子供までが使う
- 機械の知識がない素人
- 専門用語は知らない
- 点検や保守はお客様が行う
⇓ だから大きな配慮が必要です! - やさしい言葉で書く必要があります。
- 取扱いを間違うと事故の可能性があります。
誰が読者かを意識して注意事項をわかりやすく書く必要があります。
感電にゃ水が腐ると体への悪影響があることも書いてください。 - 専門用語は使ってはいけません。
使う場合は必ず解説を記載してください。 - 点検や保守は、わかりやすいイラストで説明する必要があります。
例3:パソコンに付属されているマニュアル
ご存じのように分冊になっていますね。
どんな時に読むマニュアルなのかが考えれています。
最初に読んでください、初めて起動するとき、ネットにつなぐとき、困ったとき、、、
しかし、一般的な製品ではマニュアルは1冊です。
前半を初級者用、後半を上級者用とするなどの工夫が大切です。
事故防止を配慮することが一番大切!
合理的に予見できる誤使用への配慮が一番大切です。
読者のレベルを想定して、しっかり分析してください。
開発している技術者は、読者のレベルを理解できないことが多々あります。
常識が違うからです。
テクニカルライターは、技術者と読者の橋渡しができる知識をもってください1