マニュアルのライティングスタイル

Elizabeth Slatkin 著の “How to Write a Manual" というマニュアル制作に関する書籍があります。本書は1991年に出版されたもので、マニュアル制作のプロセスや書き方について説明しています。

ユーザーマニュアルの目的は、製品の操作手順や機能をわかりやすく解説し、ユーザーが簡単に使いこなせるように、必要な情報を的確に伝えることです。この目標を達成するには、適切なライティングスタイルを習得する必要があると思います。本書の"Principles of Good Writing"（良い文章を書くための原則）という章に、優れたマニュアルを書くためのライティングスタイルが説明されています。内容を以下にざっくりまとめました。マニュアルの制作者だけではなく、翻訳者にとっても参考になると思います。

１．Accurate（正確さ）

マニュアルの内容をできる限り忠実に正確に書くこと。正確さは、読者が期待する最低限のもの。正確さがなければ、そのマニュアルはまったく役に立たない。

２．Consistent（一貫性）

構成要素、プロセス、事実関係、作業手順、概念、製品、サービス、組織、操作などは、常に同じ表現で記述する。つまり、同じ用語、同じフレーズで書いて、一貫性を保つこと。

以下については、特に注意すること。

■　ページ書式

■　テキスト書式

■　用語

■　略語

■　大文字

■　句読点

■　単位

３．Clear（明瞭さ）

ユーザーがマニュアルの内容をすぐに理解して操作できるように書くこと。「計画」、「設計」、「情報」、「言語」の能力と知識が高まるほど、文章はより明確になる。それぞれに必要な能力があるかを、下表で自問自答して自己分析する。

ーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーー

　　カテゴリー　　　　　　　｜　自己分析

ーーーーーーーーーーーーーー＋－－－－－－－－－－－－－－－－－－－－－－－

　　計画　　　　　　　　　　｜　製品とマニュアルの目的を理解しているか？

　　　　　　　　　　　　　　｜　読み手が誰なのか理解しているか？

　　　　　　　　　　　　　　｜　そのマニュアルの用途を理解しているか？

ーーーーーーーーーーーーーー＋－－－－－－－－－－－－－－－－－－－－－－－

　　設計　　　　　　　　　　｜　ページとテキストのフォーマットは明確か？

　　　　　　　　　　　　　　｜　計画と設計のアウトラインは明確か？

ーーーーーーーーーーーーーー＋－－－－－－－－－－－－－－－－－－－－－－－

　　情報　　　　　　　　　　｜　言いたいことが何かわかっているか？

　　　　　　　　　　　　　　｜　資料を理解ているか？

　　　　　　　　　　　　　　｜　適切な資料を入手したか？

ーーーーーーーーーーーーーー＋－－－－－－－－－－－－－－－－－－－－－－－

　　言語　　　　　　　　　　｜　言語技能（スペル、文法、文構造、句読法、

　　　　　　　　　　　　　　｜　ボキャブラリ、用語の使用法）を習得してるか？

ーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーー

４．Short and Simple（短くでシンプル）

段落（パラグラフ）、センテンス、単語は短く、シンプルを心がける。

・１つの題材に対して、１つの段落

・１段落は６～８行で構成

・１センテンスあたり、25ワード以内

・短い単語を使用

【例】

abbreviate → shorten

　terminate → end

subsequent → next

　 at this point in time → now

　until such time as → until

　prior to that time → before

　 on a weekly basis → weekly

　hold a meeting → meet

　with reference to → about

　 the reason why is that → because, due to

　 is equipped with → has, contains

　a larger number of → many

５．Concise（簡潔）

簡単で要領を得た文章を心がけること。

特に単語数が多くなる表現を避けること。

【例】

continue on → continue

absolutely perfect → perfect

completely unique → unique

any and all → any

advance plan → plan

current status → status

first introduction → introduction

basic essentials → essentials

joined together → joined

true facts → facts

past history → history

repeat again → repeat

６．Active（能動態）

能動態の文章は、受動態の文章より説得力があり、生き生きとした文章になる。

また、より簡潔で読みやすくなる。

【例】

〇　She poured the chemical.　←　能動態

（彼女は化学薬品を注ぎました。）

✕　The chemical was poured by her. ←　受動態

（化学薬品は彼女によって注がれました。）

〇　He breathes the air. 　←　能動態

（彼は呼吸をしている。）

✕　The air is being breathed by him. ←　受動態

（空気が彼によって吸われている。）

７．Imperative（命令形）

インストラクションでは命令形にすること。

読み手は、簡単に素早く理解できる。

【例】

〇　Move the cursor to the first field.　←　命令形

（カーソルを最初のフィールドに移動します。）

✕　You should move the cursor to the first field. ←　間接的な要求

（カーソルを最初のフィールドに移動する必要があります。）

８．Specific and Concreate（詳細で具体的）

文章には事実、数字、データを使用する。曖昧で一般的な用語は避ける。

【あいまいな文章の例】

In most cases, we feel it is useful to keep in mind that you can save aa small fortune in heating costs by carefully regulating the controls on your new system.

（多くの場合、新しいシステムのコントロールを適切に調整することで、暖房費を大幅に削減できることは、留意すべき重要な点です。）

【詳細で具体的な文章の例】

Your new Hot Air Heating System can save you up to $4.00 each day-- a 40% reduction in the average monthly heating bill in your area.

（新しい温風暖房システムは、毎日最大4ドルの節約が可能で、地域の平均的な月間暖房費を40%削減できます。）

９．Present（現在形）

時制は、できる限り現在形を使うこと。

〇　If you press the power button, the system turns on.　←　現在形

（電源ボタンを押せば、システムは（常に）起動する。）

✕　If you press the power button, the system will turn on. ←　未来または可能性を表現

（電源ボタンを押すと、システムは（おそらく）起動する。）

※will を使った場合、常に起動するのではなく、まれに起動しない場合があると言っているようなもの。

１０．Parallel（パラレリズム）

複数の概念が似通っている場合、パラレル構造にすることで明瞭、簡潔、簡単に理解できるようになる。

【パラレリズムの例】

They studied history, mathematics, and chemistry.

（彼らは歴史、数学、化学を勉強しました。）

They learned to play tennis, to swim, and to ride a horse.

（彼らはテニスをすること、泳ぐこと、そして乗馬をすることを学びました。）

【パラレリズムでない例】

They studied about history, mathematics, and how matter is constituted.

（彼らは歴史、数学、物質がどのようにできているかについて学びました。）

They learned to play tennis, swimming, and the art of horseback riding.

（彼らはテニス、水泳、乗馬の技術を学びました。）

１１．Imformal（インフォーマル）

ユーザーマニュアルの場合、会話調のトーンにしてとっつきやい文章にすること。

【ヒント】

・時々、読者を「you」として書く。

「we」や「they」などの代名詞を時々使用する。

・現在時制を使用する (アクション指向)。

・自分の書いたものを声に出して読んでみて、読みやすいかチェックする。

１２．Objective（客観的）

事実、図、データ、結果に基づいて客観的に説明すること。

１３．Interesting（興味を引く文章）

読み手のレベルを見極め、興味を引く文章を心がける。

新製品の多くは複雑なテクノロジーを駆使して開発されており、部品、機能、処理速度、オペレーションなどに関して、人間の認知、知覚（見る、触る、聞く）の範囲超えている場合がある。（例えば、「ゲート長20ナノメートル」、「１秒間に実行する命令は5億4000万個」などは、我々が認知できないレベルです。）ヒューマンスケールが知覚できる例を示して説明すると良い。

【例】

普通の説明文：

Red blood cells are biconcave and flexible. Their purpose is cellular oxygenation.

（赤血球は両凹型で柔軟性があり、その目的は細胞への酸素供給である。）

イメージしやすい文：

Red blood cells look like a crimson-velvet frisbee with a dent in the middle of both sides. Supple and elastic, they squeeze through the tiniest blood vessels to carry the breath of life, oxygen, to each cell in your body and remove carbon-dioxide waste.

（赤血球は、両側に窪みのある深紅色のベルベットのフリスビーのように見える。しなやかで弾力性があり、最も細い血管を通り抜け、生命の息吹である酸素を体中の各細胞に運び、二酸化炭素を回収する。）

マニュアル改良はこちら