【わかりやすいマニュアルの作り方】第187回用語の定義が大切

肌寒くなってきました。
バイクに乗って出かけるときには、そろそろ冬用のジャケットが必要な季節になってきました。夏の暑すぎるのもかないませんが、寒すぎるのもまたこたえます。

■用語の定義

マニュアルを作る時には、用語の定義が大切です。
別に、定義しないでドキュメントを書き続けることもできますが、あとで読み返すと定義されていない用語は本当に意味が不明になることがあるのです。
そして定義はきちんとしておくと、他の定義で理解されることがないので間違いが減少するのです。

きっちりした定義を、一行で書くことができれば、その後の良い影響は驚くほどです。
定義がきちんとするということは、そのマニュアルの中では、その用語を他の用法では使わないということです。それは後では驚くほど効果的です。
難しい事項であればあるほど、定義は後から纏めたくなります。しかし、先に定義を定めることのほうが安全で大切です。

ただし、それにはやはり「理由」が必要です。そして、その理由は大変簡単なことです。

■取扱説明書は技術文書

マニュアルは技術的なものだ、と言うことです。

たしかに、取扱説明書は、技術についてわからない人が分かるようにするために書くものですが、それでも技術文書の一種であることからは逃れられないのです。
技術文書である以上、技術の制約からは逃れられません。
その一つが「定義をしっかりすることの大切さ」なのです。

マニュアルは技術文書である。取説屋としては、これを基本として仕事をしています。

というあたりで、今週はここまでに。

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


タグ: , , , , , ,

コメントをどうぞ