取扱説明書の作り方

コンテンツ

• 説明書

取扱説明書はテクニカルライティングの分野で優れたアプリケーションです。優れた取扱説明書は、与えられたタスクを効率的かつ安全に実行できるようにするために必要なすべてのことをユーザーに伝えます。

説明書

読みたい取扱説明書の種類を書く （Fotolia.comからLeticia Wilsonによる取扱説明書を読む）

1. タスクが割り当てられる人々を特定し、彼らの理解のレベルについて考えを書きます。あなたのターゲットオーディエンスを知ることはライティングテクニックの重要な部分です。

2. それが数ページ以上含まれるならば、マニュアルの前面に要約を書きなさい。マニュアルが長すぎる場合は、裏面に索引を付けてください。

3. 定性的な用語でタスクを説明する簡単な紹介を書きます。ユーザーにタスクと、最終結果がどうなるかについての考えを伝えます。この機会は、ユーザーが正しく効率的に仕事をするのに役立つ重要なアドバイスを提供するために使用されるべきです。

4. 必要に応じて、ユーザーがタスクを完了するために必要となる関連機器および品目のリストを記入してください。取扱説明書が製品の組み立てに関するもので、組み立てられる製品に付属している場合は、ユーザーに提供されるべきであるすべての部品の個別のリストを含めてください。

5. けが、死亡、物的損害、およびその他の危険をもたらす可能性のある重大なリスクを明確に説明してください。マニュアルが販売される場所の法律に従って適切な言葉を使用してください。

6. 各ステートメントアクションを別々の手順で記述し、ユーザーがその手順を完了するために必要なすべての情報を提供します。書くことは文字通りで、要点までまっすぐでなければならず、曖昧にすることはできません。

7. マニュアルに余裕がある場合は、ユーザーにとって難しいステップをクリアするたびに図や図を含めてください。

8. 必要に応じて、タスクを完了するようにユーザーを案内するためのアドバイスのリストを作成して含めます。