当サイトのポイント
|
わかりやすいマニュアルとは、「構成が“見える”」に加え「読者の視点で“読める（書かれている）”」マニュアルと言えます。マニュアルに限らず文書の“わかりやすさ”を構成する要素は一つではありません。文書の各所に取り入れられた“見える”と“読める”の工夫によって成り立ちます。 |
文書作成の観点からわかりやすいマニュアルの要件を大別すると、「“見通しがよい”見出し構成」、「要点が明確な段落（手順を含む）」に加えて「視覚的・構造的な表現」、「読者の視点を主体にした文体」と言えます。
「何によってわかりやすい」あるいは「何によってわかりづらい」かを明らかにし適切な手法を取り入れれば、わかりやすいマニュアルにつながります。
体系的な観点で「わかりやすさ」あるいは「読みやすさ」、「見やすさ」を考えなければ、偏ったもしくは誤った解決手段でマニュアル作成が進むおそれがあります。
文書の“わかりやすさ”はいくつかの要素で構成され、かつそれを実現するのに必要な知識と手法で成り立っています。「何によってわかりやすい」が“わかっていない”と、労力とコストが報われない場合もあります。
たとえば、パソコンソフトの図解参考書がわかりやすいからといって、そのスタイルの“一部分”だけあるいは“形”だけを取り入れても“同じわかりやすさ”にはな るとは思えません。
当サイトで主として対象にするのは「わかりやすくするには工夫を要する」マニュアルです。あるいは、読者からしばしば「わかりづらいと指摘される」マニュアルです。これらのマニュアルをわかりやすくかつ効率的に作成するための解決策が当サイトのテーマである「テクニカルライティング」です。
たとえば、知識の基盤が乏しい読者に多機能な製品の操作方法を解説する場合です。
あるいは、規模が大きい製品（大型試験装置、基幹業務システムなど）の導入および設定方法を技術者あるいは運用者に解説する場合もこれに相当します。
もちろん、ページが少ないマニュアルも想定しています。コンパクトなマニュアルには、それぞれの目的に応じた工夫が必要です。
「わかりやすくするには工夫を要するマニュアル」の多くは、その製品・システムを開発された方々あるいは運用をサポートされる方々が限られた時間の中で執筆されているのが実情です。これらの方々にテクニカルライティングの知識と手法を提供し支援するのが当社の使命と考えています。
次ページに進む（ボタンをクリックしてください）マニュアルを作成する際の基本をお伝えして、テクニカルライティングへの関心をおもちいただくのが当コーナーの主旨です。
当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり、これが皆様のお役に立てば誠に幸いです。ただし、内容の一部あるいは全部の転載（他のWebサイトや他の出版物、等に収録・再配布する） および当著作物の二次使用を禁じます。
上記の主旨より、当コーナーはご覧いただいた方々に議論を呈することを目的としておりません。当社のテクニカルライティングセミナー、文書改善研修およびコンサルティングに関するお問合せ以外には、お答えいたしかねる場合がありますのであらかじめご了承ください。
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.