ユーザーマニュアルの書き方

ユーザーマニュアルは、何かを実行する方法や操作する方法を説明する、紙または電子形式 (PDF または XPS) の書面によるガイドです。「ユーザーマニュアル」という用語は、多くの場合、コンピュータソフトウェアのガイドとして考えられていますが、ユーザーマニュアルは、テレビ、ステレオ、電話システム、MP3 プレーヤーなどのコンピュータやその他の電子機器、さらには家庭用電化製品や芝生や園芸用の機器にも適用されます。優れたユーザーマニュアルは、製品の機能を効果的に使用する方法をユーザーに教えるとともに、製品の機能を理解するのに役立ち、読みやすく見つけやすいフォーマットになっています。効果的なコンテンツを作成し、ユーザーマニュアルのレイアウトを設計する際に考慮すべき事項をいくつか示します。

方法1方法1/3:

適切なユーザードキュメントを作成する

{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/0\/06\/Create-a-User-Manual-Step-1.jpg\/v4-460px-Create-a-User-Manual-Step-1.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/0\/06\/Create-a-User-Manual-Step-1.jpg\/v4-728px-Create-a-User-Manual-Step-1.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 1ユーザーが誰であるかを把握します。効果的なユーザーマニュアルを作成するには、まずユーザープロファイルを調査する必要があります。調査は、文書を作成して正式に行うか、時間をかけてユーザーの特性を分析するなどして非公式に行う必要があります。このようなプロファイルは、チームがユーザードキュメントを作成するのに役立つだけでなく、製品自体をコンセプトから完成品に変換する場合にも非常に役立ちます。ユーザープロファイルを作成する際に考慮すべき事項は次のとおりです。
- ユーザーは、自宅、オフィス、遠隔地の作業場所、車内など、どこでユーザーガイドを使用するのでしょうか。これにより、ユーザーマニュアルの内容だけでなく、採用するスタイルも決まります。
- ユーザーガイドの使い方。マニュアルの使用頻度が低く、ユーザーがたまに参照したり情報を探すだけの場合は、参照ドキュメントの形式にする必要があります。使用頻度が高く、最初はユーザーが頻繁に参照する必要がある場合は、参照セクションに「はじめに」セクションを添えて、製品が使用される最も一般的なタスクを説明する必要があります。
- ユーザーがこの製品または他の類似製品についてどの程度の経験を持っているか。製品が新しい場合、または同じカテゴリの他の製品とは大きく異なる場合は、他の製品とどのように異なるのか、また、どのように使い始めるのかを説明する必要があります。コンピュータアプリケーションなど、ユーザーが頻繁に遭遇する問題に対処する製品の場合は、適切な情報と詳細をわかりやすい方法で提供する必要があります。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/f\/f9\/Create-a-User-Manual-Step-2.jpg\/v4-460px-Create-a-User-Manual-Step-2.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/f\/f9\/Create-a-User-Manual-Step-2.jpg\/v4-728px-Create-a-User-Manual-Step-2.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 2すべてのユーザーが理解できる方法で記述します。ユーザーが技術的な背景を持っていない限り、高度な技術用語を避け、明確で理解しやすく簡潔な説明に置き換えるのが最善です。テキストの構成方法もユーザーの考え方に合わせる必要があります。通常は、使用頻度ではなく機能別に製品機能をグループ化する方が適切です。
- 一般的な円グラフや棒グラフに加えてフィボナッチ数列を含むグラフィカルソフトウェアアプリケーションを作成する場合など、専門用語を使用するのは意味をなさない場合があります。この場合、フィボナッチ数列とは何か、財務分析でどのように使用されるかを説明するなど、用語を定義し、背景情報を提供すると役立ちます。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/3\/35\/Create-a-User-Manual-Step-3.jpg\/v4-460px-Create-a-User-Manual-Step-3.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/3\/35\/Create-a-User-Manual-Step-3.jpg\/v4-728px-Create-a-User-Manual-Step-3.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 3ユーザーが解決しようとしている問題を詳しく説明し、解決策を提示します。機能をソリューションとして説明するのは、製品をマーケティングするときには便利ですが、ユーザーが製品を購入したら、その使い方を知っておく必要があります。ユーザーが直面する具体的な問題を特定し、ユーザーガイドにリストして、対応する解決策を提供します。
- 問題が複雑な場合は、小さな部分に分割します。各セクションを、その特定のセクションを解決または対処する方法の説明とともにリストし、次の各問題に順番に対処します。このように情報を分割することを「チャンキング」と呼びます。
広告する

方法2方法2/3:

ユーザーマニュアルの表示方法

{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/0\/00\/Create-a-User-Manual-Step-4.jpg\/v4-460px-Create-a-User-Manual-Step-4.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/0\/00\/Create-a-User-Manual-Step-4.jpg\/v4-728px-Create-a-User-Manual-Step-4.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 1適切な表紙とタイトルページ。ユーザーガイドには、参照カード、タイトルページ、折りたたんだ紙 (4 ページ以上) 以上のカバーを作成する必要があります。
- マニュアルが著作権で保護されている場合は、表紙とタイトルページの両方に著作権表示を含める必要があります。
- 関連商品のマニュアルや利用規約がある場合は、表紙の内側に貼ってください。
2序文に関連ドキュメントへの参照を配置します。ユーザードキュメントが複数のマニュアルで構成されている場合は、他のドキュメントを参照して正しいバージョン番号を示してください。「このガイドの使い方」セクションがある場合は、序文にも含めます。
3マニュアルが 10 ページを超える場合は、目次が必要です。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/d\/d9\/Create-a-User-Manual-Step-7.jpg\/v4-460px-Create-a-User-Manual-Step-7.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/d\/d9\/Create-a-User-Manual-Step-7.jpg\/v4-728px-Create-a-User-Manual-Step-7.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 4マニュアルの本文に指示、手順、および参照を配置します。特定のコンテンツを読むために他のセクションに移動するようにユーザーに指示することもできますが、ほとんどの場合、手順と参考資料は独自のセクションにする必要があります。これにより、ユーザーは必要な情報をより早く見つけることができます。
- 手順は、マニュアルの説明セクション内で一貫した構造で記述する必要があります。まずタスクの概要を説明し、次にユーザーが行う必要があることと、期待できる結果について説明します。ステップには番号を付け、可能であれば動詞で始める必要があります。
- 参照資料には、オプションのリスト、トラブルシューティングのヒント、よくある質問などが含まれます。マニュアルの最後に用語集と索引を追加し、よく使用される用語のリストをマニュアルの冒頭に記述することもできます。マニュアルが 20 ページ未満の場合は、索引を省略できます。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/0\/02\/Create-a-User-Manual-Step-8.jpg\/v4-460px-Create-a-User-Manual-Step-8.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/0\/02\/Create-a-User-Manual-Step-8.jpg\/v4-728px-Create-a-User-Manual-Step-8.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 5テキストをサポートするために画像を使用します。グラフィック画像 (またはスクリーンショット) は、マニュアル内の特定のポイントをテキストよりもわかりやすく説明できます。特に、ユーザーが手順を正しく実行するために視覚的な確認が必要な複雑な手順では効果的です。グラフィック画像は、コンピュータ支援描画 (CAD) またはグラフィック編集ソフトウェア、デジタルカメラ、写真編集ソフトウェアを使用して生成できます。また、コンピュータ独自のスクリーンショットツールまたはグラフィックソフトウェアに含まれるスクリーンショット機能を使用してスクリーンショットを撮ることによっても生成できます。
- 画像を作成したら、コンピューターの編集ソフトウェアがサポートする圧縮形式で保存します。必要な詳細を保持しながら、ページにうまく収まるように画像を圧縮します。 (必要に応じて、元の画像をセクションに分割し、関連するセクションをキャプションとともに表示する必要があります。)
- 1 つのステップで複数の画像を挿入する場合は、それらの画像が同じサイズ、同じ長さまたは幅、または同じ比率で拡大縮小されていることを確認してください。これにより、ユーザーにとって画像がより魅力的になります。同様に、ユーザーマニュアルにカラーのスクリーンショットが示されている場合は、コンピューターでスクリーンショットを作成するときに標準の配色を使用するようにしてください。
- Photoshop や Paint Shop Pro などのグラフィック編集プログラムには優れたスクリーンショット機能が備わっていますが、SnagIt などの専用のスクリーンショットプログラムを使用して、スクリーンショットを簡単に変更、分類、注釈付けすることもできます。
広告する

方法3方法3/3:

読みやすいユーザーマニュアルを設計する

{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/9\/90\/Create-a-User-Manual-Step-9.jpg\/v4-460px-Create-a-User-Manual-Step-9.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/9\/90\/Create-a-User-Manual-Step-9.jpg\/v4-728px-Create-a-User-Manual-Step-9.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 1読みやすいフォントを選択します。コンピューターはさまざまなフォントをサポートできますが、ユーザーマニュアルの目的は読みやすさです。いくつかのフォントを選択し、それらがうまく連携することを確認します。フォントはセリフ体とサンセリフ体の 2 種類に分けられます。
- セリフフォントとは、主線の端に微妙な装飾線があるフォントです。セリフフォントには、Times New Roman、Baskerville、Book Antiqua などのフォントが含まれます。セリフフォントは、ユーザーマニュアルの本文にある 10 ～ 12 インチの大きなテキストブロックに最適です。
- サンセリフフォントでは、Arial、Calibri、Century Gothic など、セリフ装飾のないフォントのストロークのみが表示されます。サンセリフフォントは、フォントサイズ 8 ～ 10 で PDF ドキュメントや Web マニュアルで使用できますが、セリフがないため、12 を超えるフォントは読みにくくなります。サンセリフは、タイトルには大きなフォントサイズ、脚注や列、表には小さなフォントサイズが最適です。
- 一般的に、ユーザーマニュアルは Arial や Times New Roman などの通常のフォントで記述するのが最適です。ただし、SF ビデオゲームのユーザーマニュアルを作成する場合は、装飾的なフォントを使用することをお勧めします。（重要な引用は斜体で通常のフォントで表示されることがあります。）
- 使用するフォントを決定したら、テストページを作成して、フォントが紙の上で調和して美しく見えるかどうかを確認できます。また、次のステップに進む前に、マニュアルの担当者に確認して許可を得る必要があります。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/c\/cc\/Create-a-User-Manual-Step-10.jpg\/v4-460px-Create-a-User-Manual-Step-10.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/c\/cc\/Create-a-User-Manual-Step-10.jpg\/v4-728px-Create-a-User-Manual-Step-10.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 2レイアウトについては慎重に検討してください。ユーザーマニュアルのフォントを選択したら、ページ上のすべてのコンテンツをどのようにレイアウトするかを決定する必要があります。
- 通常、ヘッダーまたはフッターにマニュアルのタイトルまたは章のタイトルを配置する必要があります。一般的には、マニュアルのタイトルを左ページに、章のタイトルを右ページに配置します。ヘッダーまたはフッターにページ番号を配置します。ページ番号は、角 (ヘッダーまたはフッター) または中央 (フッターのみ) に配置します。各セクションまたは章の最初のページを他のページと異なるものにしたい場合は、ページ番号をフッターの中央に配置し、後続のページにはヘッダーの右上隅にページ番号を配置します。
- 強調表示されたテキストを、残りのテキストから区別するために、色付きまたは網掛けのボックスに配置することもできます。テキストの邪魔にならない色や色合いを選択してください。
- 端の周りに十分なスペースを残し、綴じるためのスペースも残します。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/2\/22\/Create-a-User-Manual-Step-11.jpg\/v4-460px-Create-a-User-Manual-Step-11.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/2\/22\/Create-a-User-Manual-Step-11.jpg\/v4-728px-Create-a-User-Manual-Step-11.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 3ユーザーマニュアルの製本方法を検討します。取扱説明書が4ページを超える場合は、綴じる必要があります。社内文書はホッチキスで留めることができますが、社外向けの製品マニュアルは通常、次の 3 つの方法のいずれかで綴じられます。
- サイドバインディングは、用紙サイズ 21 x 27.5 cm、21 x 35 cm、または 27.5 x 42.5 cm で利用できます。 48 ページ以下のシンプルなマニュアルの多くは、このように製本されています。
- 中綴じ製本は、サードパーティのリファレンスガイド、自動車製品のマニュアル、その他の長いマニュアルでよく使用されます。 (JASC Software 社製の Paint Shop Pro では、中綴じのマニュアルが使用されています。)
- スパイラル綴じは、屋外などの複雑な使用環境に適しており、サイド綴じや中綴じよりも耐久性に優れています。スパイラル綴じの小冊子の中には、濡れや汚れから小冊子を保護するためにラミネート加工されているものもあります。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/3\/35\/Create-a-User-Manual-Step-12.jpg\/v4-460px-Create-a-User-Manual-Step-12.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/3\/35\/Create-a-User-Manual-Step-12.jpg\/v4-728px-Create-a-User-Manual-Step-12.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 4ユーザーマニュアルテンプレートドキュメントを作成します。多くのワードプロセッサやデスクトップ編集プログラムには、ユーザーマニュアル用のテンプレートドキュメントを作成する機能が含まれています。正常にセットアップされると、入力時に設定したフォントと位置でテキストが自動的に表示されます。 (実際、この記事はもともと Microsoft Word テンプレートを使用して作成されました。) このようなプログラムのほとんどには、最初から作成するのではなく、必要に応じて変更できるプリセットテンプレートのセットが含まれています。
- ワードプロセッサやデスクトップ編集プログラムには、ヘッダー、フッター、タイトル、本文のフォントやサイズの形式を事前に設定するための「スタイル」を作成する機能もあります。プリセットのスタイル名（「見出し1」、「標準」、「引用」など）を選択することも、独自のスタイルを作成して自分で名前を付けることもできます。同じタイプのテキストの場合は、既存のスタイルの命名規則に可能な限り従うようにしてください。 (たとえば、Microsoft Word では、見出しのテキストスタイルに「見出し 1」、「見出し 2」などという名前が付けられ、メインの見出しと複数のレベルのサブ見出しにも同じ命名形式が使用されます。) 実際の執筆プロセス中に停止して作成する必要がないように、必要なスタイルはすべて事前に作成するようにしてください。
広告する

ヒント

可能な場合は、フィールドコードまたはテキスト変数を使用します。製品名、マニュアルやセクションのタイトルなどの値を割り当てて、ドキュメントに事前に保存することができます。マニュアルをプレビューまたは印刷すると、テキストに変数が適用されます。製品名やマニュアル名、章名が変更された場合、ドキュメントを検索して置換するよりも、テキスト変数の値を変更して情報を変更する方が簡単です。

広告する