ほとんど何でものためのすばらしいユーザーガイドを書く方法

昔々、しっかりとしたユーザーマニュアルがすべての種類の新製品に付属して、すべての機能を学び、あなたの使用を最大にする方法についての広範な指示を提供しました。しかし今日では、工場提供のユーザーガイドはもっと厄介で多言語で書かれていることが多く、学習曲線が複雑になっています。まともなユーザーガイドを手に入れることは貴重な商品であり、あなたがそれを書く方法を知っているならば、これは大きな需要の中で才能です。それは単にいくつかの重要な原則を習得することの問題です。

あなたが必要とするアイテム

• Microsoft Wordまたは他のワープロプログラム

• クリップアートやデジタル写真集

• 簡単なWebページ作成ソフトウェア

印刷文書、Webページ、Eメール、またはそれらの組み合わせなど、形式を決定します。あるフォーマットで書いたら、それを別のフォーマットに転送するのは簡単です。何人かの人々は彼らが保持しそしてファイルを持ち去ることができる印刷された文書を読むのにより快適です。他の人はあなたのウェブサイト上の文書へのURLまたはリンクを好むかもしれません。

整理され、明確で簡潔になりましょう。製品ユーザーが行うことだけでなく、行わないことも予測して説明します。両方に目を向けて書く必要があります。

最初から始めて、必要な情報だけを論理的に展開します。受動的ではなく能動的な声で書いてください。余分な単語を排除して、コピーを細くします。それを単純かつ系統的にしてください。

できるだけ写真、イラスト、または図でテキストを分割します。読者に巨大な段落を含む無限のテキストを読み飛ばさせることはそれらを失うための確実な方法です。長くて複雑な段落やページは技術マニュアルには問題ありませんが、単純なユーザーガイドには不適切です。短くて甘いものにしてください。

しないことを読者に警告します。これは新製品やアプリケーションを学ぶときのフラストレーションを最小限に抑えるのに役立ちます。

あなたのガイドを補足するために彼らが使用できる他のリソースを読者に提供してください。

ヒント

• とても簡単な言葉で書いてください。いかなるレベルの知識もとらないでください。あなたにとって簡単で知識豊富なことは、読者にとってはそうではないかもしれません。高品質のグラフィック、クリップアート、写真を使用して、ドキュメントの見栄えをよくし、読みやすさを高めます。段落と説明は短くしてください。

警告

読者が製品に精通していると思い込まないでください。それぞれのガイドを一度も見たことがないように書いてください。