インストラクションを書くときは、説得力のある言葉を避け、タスクベースのアプローチをとります。

Conciseness and Clarity

Keep sentences short and understandable.The writingは簡潔かつ明確にし、ユーザーがタスクをうまく達成できるように焦点を当てる。 可能な限り一般的な用語を使用する。 イディオム、スラング、専門用語、ニックネーム、略語、頭字語の使用は避ける。

読者層

説明書を書くときに読者を知ることは重要で、必要な情報をすべて含み、不必要な情報を排除する。 読者を知ることで、読者の背景、経験、および主題への親しみに基づいて、合理的で十分な情報を得た仮定を行うことができます。 例えば、公立図書館の分館にいる高齢者のグループに向けて説明書を書く場合、彼らが特定のソフトウェアアプリケーションの開き方の基本に精通していると仮定するのは安全ではないかもしれません。

指示書に含める情報と除外する情報を決定する場合、対象者が誰で、指示書のトピックと関連する背景情報に対してどの程度の習熟度があるかを明確に識別することが重要です。

聴衆がさまざまなレベルの慣れや専門性を含む幅広い経験と知識を持つ可能性がある場合、必要な情報を提供しながらも、指示の各セットを簡潔に保ち、1 つのタスクに集中させるためにさまざまなテクニックを使用することができます。 たとえば、前提条件となる情報のために別の指示を作成し、聴衆が迅速かつ容易に別の指示にアクセスできる手段を提供することができます（ハイパーリンク、付録などを通じて）。 考えを伝えるためにグラフィックを追加することは、言葉そのものよりも効果的かもしれません。 よく図解され、文書による指示に添えられている指示は、通常、大きな成功を収めています。 それは理解の余分なレベルを追加し、問題が発生した場合に読者がざっと読んだり、トラブルシュートしたりすることができます。 写真は、読者が最終製品を視覚化することができるように、追加の次元を追加します。 また、グラフィックスを使用する場合は、視覚学習者に配慮し、グラフィックスを適応させる必要があります。

写真は素晴らしいですが、混乱を招く、または実際の書面による指示に関連していない写真やイラストを含めないよう注意する必要があります。 下手な写真と説明書を一緒にすると、読み手にストレスを与えたり、意味を読み解くのに混乱を招いたりする可能性があります。 暗かったり、ぼやけた写真は、わかりにくいことが多いものです。 被写体が混乱しないように、毎回同じ向きで撮影するように注意し、三脚の使用も検討しましょう。

説明書に画像を使用する場合は、サイズも重要です。 小さくて見づらい画像は、不鮮明な画像と同じように使い物になりません。

強力で理解しやすいように、各ステップのテキストとグラフィックは、指示のそのステップに明確に関連付ける必要があります。

書式

読者は、指示に沿って読みながら実際にタスクを実行することを忘れないでください。 だから、小さくて判読しにくいテキストの固まりを使うべきではありません。 読みやすく、美観を損なわないようなデザインとレイアウトを指示ページで実現するようにしましょう。 ページをシンプルに保ちつつ、階層を明確にすることで、読者が指示の手順を完了するのを助けます。

ページをデザインするとき、しっかりとした階層を作ることがスキャンビリティのために重要です。 太字の見出し、斜体、ローマ数字を使用すると、読者が自分の場所を簡単に見つけることができ、全体的な視覚的外観に役立ちます。

順序

あなたの指示が論理的進行で計画されていることが重要です。 最初のページで問題を明確に記述してください。 問題の後に、提案された問題を解決する方法を詳述した一連の具体的な手順を記述してください。 技術的な指示は、論理的なパターンで流れなければなりません。 例えば、テーブルを組み立てる場合、ネジが全部揃う前に仕上げをするのは良くありません。 また、前述したように、動作を明確にするために、必要な部分には明確な図解が必要です。 百聞は一見にしかず、です。

テストと検証

説明書を書くのが難しいこと、紙の上ではよくても、実際に使用しようとすると、自分の表現が他の人にとって意味がわからないということがあることは、誰もが知っていることでしょう。 自分にとっては当たり前のことでも、読者にとっては不可解なことである可能性があることを認識し、読者を理解しましょう。 説明書を自分でテストするだけでなく、製品について何も知らない人にテストしてもらいましょう。 これはユーザビリティスタディと呼ばれます。 何がうまくいき、何がうまくいかなかったかをメモし、それに応じて説明書を修正しましょう。 長い目で見れば、より多くの人が説明書をテストすればするほど、最終的な説明書はより効果的なものになります。