

「わかりやすいマニュアル」の要件
| |
わかりやすいマニュアルとは,読者にとって「理解の
負担となる要素」が少なく,かつ「理解を促進する手法」が効果的に取り入れられたマニュアルと言えます.
|
「わかりやすい/わかりづらいの議論
」から「わかりやすいを実現する手法」へ
文書作成の観点から「
わかりやすいマニュアルの要件」を大別すると,「“見通しがよい”見出し構成」,「要点が明確な段落(手順を含む)」に加えて「視覚的
・構造的な表現」に加えて「読者の視点を主体にした文体」と言えます.「何によってわかりやすい」あるいは「何によってわかりづらい」かを明らかにすれば,わかりやすいマニュアルにつながります.
文書の“わかりやすさ”はいくつかの要素で構成され,かつそれを実現するのに必要な知識と手法で成り立っています.「何によってわかりやすい」が“わかっていない”と,わかりやすいマニュアルにつながらないばかりか労力とコストが報われない場合もあります.

「わかりやすく作成するには工夫を要する」マニュアルの“わかりやすい”化
当サイトで主として対象にするのは「わかりやすく作成するには工夫を要する」マニュアルです.あるいは,読者から「わかりづらい」と指摘されやすいマニュアルです.
-
たとえば,知識の基盤が乏しい読者に多機能な製品の操作方法を解説する場合です.
-
あるいは,規模が大きい製品(例:大型試験装置,基幹業務ネットワーク)の応用的な取扱い方法を技術者あるいは運用者に解説する場合もこれに相当します.
-
もちろん,ページが少ないマニュアルも想定しています.コンパクトなマニュアルには,それぞれの目的に応じた工夫が必要です.
「わかりやすく作成するには工夫を要するマニュアル」の多くは,その製品を開発された方々あるいは運用をサポートされる方々が限られた時間で執筆されているのが実情です.これらの方々にテクニカルライティングの知識と手法を提供し支援するのが当社の使命と考えています.

次ページに進む(ボタンをクリックしてください)
<当コーナーの主旨とご閲覧にあた
ってのお願い>
|
当コーナーは,当社のテクニカルライティング研修コース(出張開催セミナー)の抜粋・プレビュー版です.
-
当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり,これが皆様のお役に立てば誠に幸いです.ただし,内容の一部あるいは全部の転載(他のWebサイトや他の出版物,等に収録・再配布する)
および当著作物の二次使用を禁じます.
-
また,上記の主旨より当コーナーはご覧いただいた方々に議論を呈することを目的としておりません.当社セミナーの開催に関するお問合せ以外には,お答えいたしかねる場合がありますのであらかじめご了承ください.
|

実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com