ユーザーマニュアルを作る方法

この記事には:適切なユーザーマニュアルを作る項目をアレンジする読みやすいマニュアルをデザインする出典

ユーザーマニュアルは、何かを使ったり行う時にどうしたら良いかが書かれた指示書のことで、通常はハードコピー(紙面)または電子書面(PDFまたはXPS形式)の形をとっています。「ユーザーマニュアル」と言うとコンピューターソフトウェアのマニュアルのことをまず思い浮かべるでしょうが、テレビやステレオ、電話、MP3プレーヤーといったAV機器や電子機器、また家電や庭道具にも付いてきます。良く出来たマニュアルは製品の特性を紹介するだけでなく、その機能をどうしたら効果的に使えるのか、分かりやすく教えてくれます。では、効果的なマニュアルを作成するために考慮すべきポイントと、レイアウトのコツを見ていきましょう。

パート 1
適切なユーザーマニュアルを作る

  1. 1
    ユーザー層を明確にしましょう。本当に役立つマニュアルを作るためには、ターゲットとなるユーザー層についてきちんとそのプロフィールまで書き出すか、あるいはもっと簡単にすませる場合は、その層の特性について想像してみましょう。こうしてユーザー層を明確にしておけば、複数人のチームでユーザーマニュアルを作っている時に役立ちますし、対象製品をコンセプト段階から最終的な形態にまで固めていく際にも役立ちます。ユーザー層を定義する際に考慮するべきポイントは次の通りです。
    • ユーザーはどこでマニュアルを使うのか。自宅、オフィス、あるいはリモートオフィスや車の中などが例として挙げられます。使用場所に応じて、マニュアルはその内容だけでなく、形式も変化させるべきでしょう。
    • マニュアルをどのように使うのか。たまにしか見ないものだったり、情報を参照するためにしか使われないものだとしたら、参照用ドキュメントの形式をとるべきでしょう。製品を使い始める時に何度も参照する必要が生じるものであれば、冒頭に「スタートガイド」部分を作成して、最もよく使われる機能についての説明を載せておきましょう。
    • ユーザーがその製品あるいは類似商品にどれだけ慣れているか。もしあなたの販売する製品が類似商品と著しく異なる特徴のものの場合は、それが類似製品とどう違うのかと、簡単な使い方も説明しておくべきでしょう。コンピューターソフトウェアのように、よくトラブルに見舞われる物であれば、その事に対してユーザーが納得いくような詳細な情報も、記載しておくべきでしょう。
  2. 2
    あらゆるユーザーにとって分かりやすい書き方とフォーマットを心がけましょう。技術用語を使用するのはユーザー層が技術的な背景知識を持っている事が確実な場合のみに限定して、分かりやすいシンプルな説明を心がけましょう。また説明は、ユーザーの立場になったつもりで、書き方を考えましょう。たとえば、単によく使われる機能をまとめるよりも、機能ごとに分類して製品の特徴をまとめた方が分かりやすいものです。
    • 時には専門用語を避ける事が出来ないこともあるでしょう。円グラフや棒グラフだけでなくフィボナッチ数列を利用したグラフまでも作画することが出来る、作画ツールのマニュアルの場合などです。その場合は、用語の定義や説明を加えておくと親切です。フィボナッチ数列とは何かという事や、どのように株価や為替の分析に使われるのか、といったような説明があるとわかりやすいでしょう。
  3. 3
    ユーザーが解決したいであろう課題を取り上げて、解決策を加えましょう。一般的な問題に対する解決策として製品の特徴を紹介するのは、その製品のマーケティング時には有効な手段ですが、いったん製品を入手したユーザーは、実際にその製品を役立てたいと思っています。ユーザーが直面するであろう具体的な課題を取り上げて、それを解決するための手順をマニュアルに加えておきましょう。
    • 解決すべき課題が複雑な場合は、小さく分割して考えましょう。分割して小さくした課題それぞれに対する解決法や対処法を列記していきましょう。このように情報を小さく分割して考える手法は、チャンキングと呼ばれます。

パート 2
項目をアレンジする

  1. 1
    適切な表紙と、表題ページを作りましょう。単なる参照カードでなければ表紙は必要ですし、折りたたんだ紙ですませるのでなければ(4ページ以上の長さの場合は)表題ページも必要です。
    • マニュアルを著作権で保護するのであれば、表紙とタイトルページの両方に著作権表示を行いましょう。
    • マニュアルと製品を使うにあたっての前提条件がある場合には、表紙の内側に書きます。
  2. 2
    他に関連するドキュメント類がある場合は、前書き部分に参照資料として引用します。ユーザー向けマニュアルや文書が複数ある場合は、バージョン番号とともに記載します。また「ユーザーガイドの使い方」も、掲載する場合は同じく前書き部分に記載します。
  3. 3
    マニュアルが10ページ以上に渡る場合は目次も作成します。
  4. 4
    本文部分に説明書きや使用法、参照すべき資料などについて書き込みます。通常であれば製品の使用方法や参照資料についてはそれぞれ別のページを設けますが、特定の項目を参照するように書き示しておけば、ユーザーは欲しい情報を素早く見つける事が出来るでしょう。
    • 製品の使用手順は一貫性のある書き方で載せましょう。まず概略として実現しようとしている状態を、それからそのためにユーザーが取るべき手順と得られる結果について書きます。手順には順番に番号をふり、またこの記事の見出しもそうなっていますが、動詞を含めて取るべきアクションが分かるように書きましょう。
    • 参照資料の部分には、オプション機能やトラブルシューティングのヒント、よくある質問などを記載しましょう。用語集や索引はマニュアルの巻末に載せるのが普通ですが、頻出用語は冒頭に載せても良いでしょう。ページ数が20に満たない場合、索引は割愛しても構いません。
  5. 5
    文章を補完する画像やイメージを加えます。画像やスクリーンショットは、ユーザーが複雑な手順を正確に踏まなければならない場合は特に役立ちます。画像イメージにはCADや画像編集ソフト、あるいはデジタルカメラや写真編集ソフトなどを使います。スクリーンショットを利用する場合にはパソコンに予めインストールされている機能を使うか、同様の機能をもったグラフィックプログラムを使います。
    • 画像を用意したら、自分の使っているテキストエディタで使える形式で圧縮して保存しておきます。また、ユーザーにとって必要な情報を損なわない程度に、出来るだけ容量を小さくしておくと良いでしょう(必要に応じてオリジナルの画像を分割して、必要な部分だけを説明書きを加えながら載せるという手もあります)。
    • 複数の画像を使う場合は縦横が同じサイズになるように、またオリジナルサイズからの縮小比率が同じになるようにすると、とても見やすくなります。またコンピュータ画面のスクリーションショットをカラーで載せる場合は、画面が標準的な色調で設定されていることを確かめてから撮りましょう。
    • フォトショップやペイントショッププロと言った画像処理ソフトでもスクリーションショットは撮れますが、画像キャプチャに特化したSnagIt(スナグイット)といったソフトウェアなら画像を編集して並べたり、注釈をつけるのも簡単です。

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

  1. 1
    読みやすいフォントを選びましょう。コンピューターには無数のフォントが入っていますが、最終的にユーザーマニュアルは読みやすくなければなりません。そのためにフォントの種類は出来るだけ少なく、かつ一緒に使った時にも読みやすい組み合わせのものを選びましょう。欧文活字の場合は、書体は大まかにセリフ体とサンセリフ体という二種類に分類されます。
    • セリフ体は、その文字を構成する線の終わりに髭のような小さな飾り部分があります。セリフ体の中で有名なものは、Times New Roman(タイムズ・ニュー・ローマン)やBaskerville(バスカービル)、Book Antiqua(ブック・アンティーカ)などです。セリフ体は紙のマニュアルの本文として、10から12ポイントの大きさで大量の文字を載せる場合に適しています。
    • サンセリフ体にはセリフ体のような飾り部分はありません。Arial(エリアル)やCalibri(カリブリ)、Century Gothic(センチュリー・ゴシック)などが有名です。サンセリフ体は、PDFやウェブ画面上に8から10ポイントで大量に文字を表示する場合に向いています。飾り部分が無いため、12ポイント以上の大きさで表示すると読みづらくなるでしょう。ただし大きめのサイズでも表題や見出しとして使うと効果的ですし、また脚注に使ったり表中の文字を入力する場合にも適したフォントです。
    • 通常はArialやTimes New Romanといった一般的なフォントを使用するのが良いでしょう。しかし引用文を掲載する場合や、またファンタジーやSFのビデオゲーム用マニュアルなどに使用するのであれば、もっと装飾的なフォントを選ぶのも良いでしょう。
    • フォントを決めたら、実際に紙の上でどう見えるかが分かるような見本のページを作成しましょう。そしてそれ以上作業を進める前に、マニュアルの装丁を承認する権限のある人に確認してもらうと良いでしょう。
  2. 2
    レイアウトを検討しましょう。フォントを選んだ後は、ページのレイアウトについて考えてみましょう。
    • 一般的には、ヘッダーかフッターにマニュアルの名称や章のタイトルを入れます。多くの場合、マニュアル名は左手、章のタイトルは右手のページに入れます。ページ番号はページの端(ヘッダーまたはフッターに)、あるいは真ん中(フッターのみ)に入れましょう。各章や節の最初のページは、他のページとレイアウトを変えると良いでしょう。またページ番号は最初のページだけフッターの真ん中に入れて、後のページではヘッダーの端に入れるなどします。
    • キャッチフレーズや補足説明などは、本文と区別しやすいように色や影のついたボックスの中に入れると良いでしょう。その際、本文の邪魔にならないように色や影の密度を調整しましょう。
    • ページのどの側にも、十分な余白をとりましょう。特に綴じる側には余分に余白を設けましょう。
  3. 3
    綴じ方を検討します。ユーザーマニュアルが4ページ以上ある場合は、何らかの方法で綴じなければなりません。社内で使うぶんには角をホチキスで留めるだけでも足りるでしょうが、製品とともに出荷するマニュアルの場合、通常は次の三つのうちのどれかの方法を取ります。
    • 折りたたんだ紙の際をホチキス留めする方法は、A4からB4程度の大きさの紙を折りたたんだマニュアルに適しています。ページ数が48枚よりも少ない場合は、この方法が良いでしょう。
    • 中綴じと呼ばれる方法は、自動車以外の製品の参照ガイドを綴じる際に多く使われる方法ですが、ぶ厚いマニュアルを綴じる際にも使われます(ペイントショッププロも、もともとJASC Softwareが販売していた頃は中綴じで出荷されていました)。
    • らせん綴じはアウトドアなど、厳しい環境のもとで使われるユーザーガイドに向いています。そういった環境下ではホチキス留めや中綴じといった方法では、ページがばらばらになってしまうでしょう。らせん綴じでは、水や泥に濡れても大丈夫なようにラミネート加工されたページを挟み込むこともあります。
  4. 4
    あなたのマニュアル専用のひな形を作りましょう。ワープロやDTPプログラムの中にはテンプレート(ひな形)書面を作成する事の出来る物も多く、それを使えば載せたい文字を打ち込むだけで、所定の位置に設定してあるフォントを自動的に呼び出して掲載するといったことが出来ます。(実際のところ、この記事は当初マイクロソフトWordのテンプレートを使って書いたものです。)また予め各種のテンプレートが用意されていることも多く、好みに応じて少し手を加えるだけで良いので自分で一から作る必要がありません。
    • ワープロやDTPソフトにはまた、予め選んだフォントや文字サイズを使ったヘッダーやフッター、見出しや本文として使える「スタイル」を設定する事ができるようになっています。予め用意されている、よく使われるスタイル(例:「見出し1」「本文」「引用」)を使っても良いですし、自分独自のスタイルを作成して名前をつけることも出来ます。同じ階層のテキストに対して複数のスタイルを使い分ける場合は、出来るだけ既存のルールに習って名称をつけるようにしましょう。(例えば、マイクロソフトのWordでは、大見出しから小見出しに至るまで、見出し用のスタイルには「見出し1」「見出し2」等の名称がつけられています。)またスタイルを作成するためにマニュアルを書く作業を中断せずに済むように、予めすべてのスタイルを作成しておきましょう。

ポイント

  • フィールドコードやテキスト変数と言った機能を使いこなしましょう。これらの機能を使えば、製品の名称、マニュアルや章のタイトルと言ったものを値として割り当てることが出来るので、実際に文字を打ち込まなくてもドキュメントの中に値として引用してくることが出来ます。マニュアルをプレビュー画面で見たり印刷すると、製品名称等が変数の値として表示されるのです。製品名やマニュアル名、章の名称を変更した場合なども、全体を検索して単語を置き換えるよりも変数の値を変更する方が、ずっと簡単です。

必要なもの

  • ワープロまたはDTP用ソフトウェア
  • 画像加工またはスクリーンキャプチャ用ソフトウェア

記事の情報

wikiHowは「ウィキ」サイトの一つであり、記事の多くは複数の著者によって共著されています。 この記事は、著者の皆さんがボランティアで執筆・推敲を行い、時間をかけて編集されました。

カテゴリ: 仕事

他言語版:

Español: hacer un manual de usuario, Italiano: Creare un Manuale d'Uso, Português: Criar um Manual do Usuário, Русский: составить руководство пользователя, Deutsch: Eine Bedienungsanleitung schreiben, Français: créer un manuel d'utilisateur, العربية: تصميم كتيب الاستخدام, Nederlands: Een handleiding maken, Bahasa Indonesia: Membuat Panduan Pengguna, 中文: 编写用户说明书, 한국어: 유저 매뉴얼을 만드는 방법

このページは 170 回アクセスされました。
この記事は役に立ちましたか?