ユーザーマニュアルの作成方法

ニュース 公開 タグ 情報源 私たちについて プライバシー
GratisForGratis

WikiHow

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

ユーザーマニュアルは、何かの実行方法や使用方法についての指示を提供する、物理的に書かれたガイド (紙) または電子文書 (PDF または XPS) です。「ユーザー ガイド」はコンピュータ ソフトウェアに関連するものと最も一般的に考えられていますが、ユーザー マニュアルはコンピュータやテレビ、ステレオ、電話、MP3 プレーヤーなどの他の電子機器、家庭用電化製品や庭の設備にも添付されています。優れたユーザーマニュアルは、ユーザーに製品の機能を知らせ、効果的かつ簡単にアクセスできる方法でそれぞれの操作を教えます。ユーザーマニュアルの効果的なコンテンツとレイアウトを作成する際に考慮すべき要素を以下に示します。
一部 1
パート 1/3:

ユーザーフレンドリーなドキュメントの作成

PDFをダウンロード
  1. Step 1 Definisci l’utente di riferimento.
    成功するマニュアルを作成するには、書面によるプロファイルを作成することによって正式にユーザーをプロファイルするか、時間をかけてユーザーの特性について合理的な仮定を立てて非公式にユーザーのプロファイルを作成する必要があります。このようなプロファイルは、ユーザー ドキュメントを作成するチームの一員である場合に役立ちます。また、製品をアイデアから最終形態に移行するプロセスにも役立ちます。ユーザー プロファイルを作成する場合、考慮すべき要素は次のとおりです。
    • ユーザーがマニュアルを使用する場所は、自宅、オフィス、離れた職場、車内などです。これは、内容だけでなくマニュアルのスタイルにも影響を与える可能性があります。
    • ユーザーがガイドをどのように使用するか。マニュアルを参照する必要がほとんどない場合、または情報を検索する必要がある場合は、主に参照文書の形式を取る必要があります。最初にユーザーが頻繁に参照するものである場合は、リファレンス セクションに「はじめに」セクションと、製品の最も一般的な使用方法に関する説明を追加する必要があります。
    • ユーザーが同じカテゴリの製品または他の製品に関してすでにどの程度の経験を持っているか。製品が新しい場合、または類似製品と大きな違いがある場合は、それらの違いの説明と、その使用を開始する方法の説明を含める必要があります。多くのコンピューター アプリケーションなど、ユーザーが頻繁に問題を抱える問題に製品が対応している場合は、適切な情報と詳細をわかりやすい形式で提供する必要があります。
  2. Step 2 Rivolgiti ai bisogni del tuo utente in modo che questi possa capire.
    ユーザーに技術的な経験がない限り、特定の用語を避け、明確で単純な説明を優先するのが最善でしょう。テキストは、ユーザーの推論に対応できるように編成する必要もあります。製品の機能を機能ごとにグループ化してリストすることは、一般的に使用されるリストの順序よりも合理的であることがよくあります。
    • 場合によっては、より一般的な円グラフや棒グラフに加えてフィボナッチ チャートを含むチャート ソフトウェアの場合など、専門用語を回避する方法がありません。同様のケースでは、財務分析におけるフィボナッチ テーブルの定義と有用性を詳しく掘り下げるなど、用語を定義して説明すると便利です。
  3. Step 3 Spiega il problema che l’utente sta cercando di risolvere, poi presentane la soluzione.
    製品の販売段階では、一般的な問題に対する解決策のみを提供することは効果的ですが、ユーザーは製品を購入した後、それを最適な方法で使用する方法を理解する必要があります。ユーザーが遭遇するであろう具体的な問題を特定し、それをユーザー ガイドに記載してから、問題を解決するための指示に進みます。
    • 問題が複雑な場合は、より小さな部分に分割します。各部分を解決方法や対処方法とともにリスト化し、順番に並べます。このプロセスは「チャンキング」として知られています。
    広告
一部 2
パート 2/3:

ユーザーマニュアルの要素

PDFをダウンロード
  1. Step 1 Includi la copertina e i frontespizi appropriati.
    各ユーザー ガイドには、単なるリファレンス カード以上の表紙が必要です。また、折り畳んだ紙より長い (4 ページ以上の長さ) マニュアルの表紙も必要です。
    • マニュアルが著作権で保護されている場合は、表紙とタイトルページの両方に明記する必要があります。
    • マニュアルおよび関連製品の使用条件を報告する必要がある場合は、表紙の内側に記載する必要があります。
  2. Step 2 Inserisci riferimenti ai documenti collegati nell’introduzione.
    ユーザー ドキュメントが複数のボリュームにまたがる場合は、ここに他のドキュメントへの参照を正しいバージョンとともに提供してください。イントロダクションは、必要に応じて「このガイドの使用方法」セクションを挿入できる部分でもあります。
  3. Step 3 Includi un indice, in caso il manuale superi le 10 pagine.
  4. Step 4 Metti le istruzioni/metodi e i materiali di riferimento nel corpo centrale del manuale.
    多くの場合、メソッドと参考資料にはそれぞれ独自のセクションが必要ですが、あるセクションから別のセクションへ特定のコンテンツを参照するようにユーザーにいつでも指示できます。これにより、ユーザーは探している情報をより速く見つけることができます。
    • メソッドは、マニュアルの手順セクション全体で一貫して記述する必要があります。タスクの概要から始めて、ユーザーが何をする必要があるか、どのような結果を達成する必要があるかを説明します。この記事の各セクションのステップと同様に、ステップには番号を付け、動作動詞で始める必要があります。
    • 参考資料には、オプション、ヒント、よくある質問のリストが含まれる場合があります。用語集と付録はマニュアルの最後に追加される場合がありますが、一般的に使用される用語のリストが最初に表示される場合があります。マニュアルのページ数が 20 ページ未満の場合、索引は省略できます。
  5. Step 5 Usa delle grafiche qualora sia necessario sostenere il testo.
    特にユーザーが正しい実行を視覚的に確認する必要がある複雑な手順では、グラフィックまたはスクリーンショットのほうが、テキストよりもマニュアル内の特定のポイントをわかりやすく説明できます。グラフィックスは、CAD プログラムやグラフィックス ソフトウェア、デジタル編集やデジタル カメラを使用して作成できます。また、スクリーン ショットの場合は、コンピュータの内蔵機能 (「スタンプ」/cmd+shift+3) または、画面録画オプション。
    • グラフィックを作成したら、プログラムの作成または公開に使用できるように、圧縮形式で保存します。また、ユーザーの詳細を損なわずにページに含めやすくするために、ファイル サイズを小さくすることもできます (必要に応じて、元の画像を分解して、テキストを読み進めるときに関連する部分を表示する必要がある場合があります)。 。
    • メソッド内で多数のグラフィックスを使用している場合は、すべて同じ長さと幅であるか、元のサイズから常に同じ比率に縮小されているかにかかわらず、寸法の一貫性を維持してください。これにより、画像がユーザーにとってより魅力的なものになります。同様に、スクリーン ショットをコンピュータに保存するときは、マニュアルで標準の色を保持することが求められている場合に備えて、この手順でコンピュータが標準の色に設定されていることを確認してください。
    • Photoshop や Paint Shop Pro などのグラフィックス プログラムは優れた画面保存機能を提供しますが、SnagIt などの特殊プログラムを使用すると、画面を簡単に編集、カタログ化、固定することもできます。
    広告
一部 3
パート 3/3:

読みやすいマニュアルをデザインする

PDFをダウンロード
  1. Step 1 Scegli un paio di font leggibili.
    コンピュータはさまざまなフォントをサポートしていますが、ユーザー マニュアルの目標は読みやすさです。この目標を達成するには、よく一致するフォントをいくつか選択することが最善の方法です。フォントには 2 つのカテゴリがあります。「セリフ」と「サンセリフ」（セリフの有無にかかわらず）。
    • Serif フォントには、文字の主要なストロークの端に小さな終端があります。Serif フォントには、Times New Roman、Baskerville、Book Antiqua などがあります。セリフは、印刷されたユーザー マニュアルの本文の 10 ～ 12 サイズの大きなテキスト ブロックで最適に機能します。
    • サンセリフ フォントは、文字を形成するストロークのみを示し、終わりはありません。サンセリフには、Arial、Calibri、Century Gothic などがあります。これらのフォントは、オンライン マニュアルや PDF のサイズ 8 ～ 10 のテキストの大きなブロックに使用できますが、語尾がないため、サイズ 12 以上の文は読みにくくなります。ただし、大きなサイズで見出しや見出しを表示するのに効果的に使用でき、小さなサイズでもフッターや列や表の数字に同様に適しています。
    • ユーザーマニュアルには通常、Arial や Times New Roman などの中立的なフォントを選択する必要があります。ただし、引用符やタイトルの場合は装飾的なフォントを選択することをお勧めします。たとえば、ファンタジーや科学を含むビデオゲーム用に書いている場合は、フィクションの設定 (同じテキストからの抜粋の場合、多くの場合、同じフォントを「斜体」形式で使用できます)。
    • 使用するフォントを選択したら、テスト ページを作成して、フォントが紙上で適切に表示されるかどうかを確認します。続行する前に、マニュアルの外観を承認する必要がある人にこの証明を見せることもできます。
  2. Step 2 Pensa all’impaginazione.
    ユーザーマニュアルのフォントを選択したら、ページのさまざまな要素の位置を決定する必要があります。
    • 通常は、マニュアルまたは章のタイトルをヘッダーまたはページの下部に配置します。理想的には、左側のページにマニュアルのタイトル、右側に章のタイトルを使用します。ページ番号は、上または下、外側（ヘッダーまたはフッター）、または中央（フッターのみ）に配置する必要があります。各セクションまたは章の最初のページを他のページと区別するには、そのページ番号を中央に配置し、それ以降のページ番号をヘッダーの外側の隅に配置するとよいでしょう。
    • テキストの一部を色付きまたは影付きのボックスで描画して、残りのテキストから分離することができます。必ずテキストと重ならない色または陰影の程度を選択してください。
    • すべての側面に適度な幅の余白を残し、綴じられる端には十分なスペースを確保します。
  3. Step 3 Considera il tipo di rilegatura del manuale d’uso.
    マニュアルが 4 ページを超える場合は、何らかの方法で綴じる必要があります。内部文書は角の 1 つをホッチキスで留めることができますが、製品に付属の外部マニュアルは通常、次の 3 つの方法のいずれかで綴じられます。
    • サイドステープルは、21×27.5cm、21×35cm、または27.5×42.5cmの紙を折りたたんだマニュアルに適しています。48 ページ未満のほとんどの経済マニュアルはこのように綴じられています。
    • サイドシームは、自動車以外の製品に付属する取扱説明書ではなく、外部リファレンス ガイドによく使用されますが、一部の長いガイドはこの方法で綴じられています (ペイント ショップ プロは、JASC ソフトウェアによって製造されたときに、最初はシーム綴じされたガイドとともに出荷されました) ）。
    • スパイラル綴じは、屋外環境など、ホッチキスで留めたマニュアルでは抵抗が少ない、より堅牢になるように設計されたユーザー ガイドに適しています。スパイラル綴じのマニュアルの中には、水や泥との接触による損傷を防ぐために、ページがラミネート加工されているものもあります。
  4. Step 4 Costruisci un modello per il tuo manuale.
    多くの作成および公開プログラムでは、ユーザー マニュアルのテンプレート ドキュメントを作成する機能が提供されており、作成すると、マニュアルの作業中の部分内のテキストが希望のフォントで自動的に表示されます (実際、この記事は最初は MS Word テンプレートを使用して作成されました)。これらのプログラムの多くには、テンプレートを最初から作成するのではなく、ニーズに合わせて変更できる既製のテンプレートのセットも含まれています。
    • プログラムを作成および公開すると、ヘッダー、フッター、タイトル、テキスト本文のプリセット フォントとサイズである「スタイル」を作成することもできます。事前定義されたスタイル (「見出し 1」、「標準」、「引用」など) の 1 つを選択することも、独自の名前を付けて独自のカスタム スタイルを作成することもできます。同じテキストに複数のスタイルがある場合は、できる限り、機関スタイルの命名規則に従ってください (たとえば、MS Word では、見出しスタイルに「見出し 1」、「見出し 2」などのラベルが付けられます)。メインからさまざまなサブタイトルまで、タイトルごとに）。実際の執筆プロセス中にスタイルの作成を中止する必要がないように、必要なすべてのスタイルを事前に作成するようにしてください。
    広告

アドバイス

  • 可能な限りコード変数とテキスト変数を有効に活用してください。製品名、マニュアルや章のタイトルなどの値を割り当てて、実際のテキストを記述するのではなく、ドキュメント内にそれらを配置できます。ドキュメントをプレビューまたは印刷すると、変数がテキストに置き換えられます。製品名が変更された場合、またはマニュアルや章の名前が変更された場合は、文書内で検索して置換するよりも、テキスト変数の値を置換する方が簡単に情報を変更できます。
広告

必要なもの

  • プログラムを書いたり出版したりする
  • グラフィックスまたはビジュアル記録プログラム
以下に基づいてライセンスを取得: CC-BY-SA
CAPTCHA

サイトを発見GratisForGratis

広告

 

^