資料請求

  • twiiter
  • twiiter
  • twiiter

BLOG

ブログ

  • LINE
  • facebook
  • Twitter

2022年07月16日

マニュアル作成のコツとは 基本から作り方のポイントを解説!

マニュアル作成のコツとは 基本から作り方のポイントを解説!

目次

  • マニュアルとは?
  • マニュアルの基本的な作成手順
  • わかりやすいマニュアルを作成するためのポイント
  • まとめ

わかりやすくサービスの操作方法や機能を説明するマニュアルは、ユーザーにサービスを活用してもらうために重要な役割を果たします。

とはいえ、マニュアル作成にお悩みの方も、少なからずおられるのではないでしょうか。

 

「一からマニュアル作成を行った経験がなく、何から手を付ければよいかわからない」

「どういった点に気をつければ、わかりやすいマニュアルになるのかわからない」

「マニュアルはどんなタイミングで更新すべきか迷っている」

 

本記事では、ユーザー向けマニュアルの作成をはじめて行う方向けに、作成手順やポイントを基本から解説していきます。

 

マニュアルとは?

はじめに、改めてマニュアルとはどういったものであるかを確認していきます。

マニュアルの目的や意味を迷いやすい類語について理解した上で、マニュアル作成に取り組みましょう。

 

マニュアルの意味と目的

マニュアルとは、サービスの機能、正しい操作方法やトラブル発生時の対処方法を伝えるためのドキュメントです。

マニュアルを参照することで、ユーザーが行うべき作業をひと目で確認でき、かつ正しく理解できるものになっている必要があります。

サービスの利用に必要な情報を網羅し全体をフォローしつつ、ユーザーが迷いそうなポイントに比重を置くなど、ユーザー目線のものになっていることが理想的です。

また、マニュアル内で探したい部分のみをすぐ確認できるように検索性も高めるなど整備することで、ユーザーからの問い合わせ対応の稼働削減にもつながります

 

手順書との違い

マニュアルと手順書の違いは、解説の対象となる操作や作業の範囲です。

マニュアルはあるサービスの使い方を網羅的に含みますが、手順書は個別の作業ごとに作成されることが一般的です。

手引き書との違い

手引き書は、作業の手順や進め方をまとめたドキュメントです。

マニュアルと比較して、手引き書には限定した範囲の情報のみが簡潔にまとめられます

 

ハンドブックとの違い

ハンドブックはその名の通り、手で持ち運べる程度のコンパクトさにまとまったドキュメントであることが特徴です。

サービス全体をカバーするため情報量が豊富なマニュアルと異なり、ハンドブックでは必要最低限に絞って情報がまとめられています

 

取扱説明書との違い

取扱説明書で扱われるのは、個別の機器やソフトの仕様・操作方法です

一方マニュアルでは、サービスの使い方全体を説明します。

 

マニュアルの基本的な作成手順

それでは、マニュアルを作成する際の具体的な7つのステップについて確認していきましょう。

 

マニュアルの作成手順

マニュアルの作成手順

 

①マニュアルを提供するターゲットを明確にする

最初に、マニュアルを提供する対象のユーザー像を明確にしましょう。

ターゲットユーザーのサービスに対する理解度リテラシー普段慣れ親しんでいる媒体などによって、適切なマニュアルの内容や提供方法は異なります

作成するマニュアルが自社サービスのユーザーにとって最適なサポートツールとなるよう、まずはターゲットの特性を捉えるところからはじめましょう。

 

②対象の操作・機能を洗い出す

マニュアルで解説する対象の操作や機能を、一通りすべて洗い出しましょう。

このステップで抜け漏れがあると、一度作成した構成の作り直しなど、手戻りの発生につながります

なお洗い出し後は後の工程で参照できるよう、リスト化するなどしてまとめておくことをおすすめします。

 

③マニュアルの構成を作成する

洗い出した操作や機能をどのような順序で解説するか、マニュアルの構成を検討します。

サービスの特徴や解説のボリュームなどによって適切な構成はさまざまです。ユーザーが理解しやすく、必要な情報を探しやすいマニュアルの構成となるよう配慮しましょう。

 

例えば、マニュアルの章立ての例としては以下のようなものがあります。

・機能単位

・プロダクトの画面単位

・利用開始からのフェーズ単位

 

④操作・機能の実態を確認する

マニュアルの構成が決まったあとは、操作や機能の解説内容を作成していきます。

 

ここで、想像や記憶だけを頼って作成することがないようにしてください

「自社のサービスだからわかっているはず」「確かこういう挙動だったと思う」といった曖昧な認識でマニュアル作成をすすめると、誤った内容をユーザーに伝えてしまいかねません。

場合によっては機能のアップデートや改修に伴い、操作が変更になっていることもあるでしょう。

 

一度ユーザーに公開してしまった誤った情報を訂正するためには、企業側とユーザー側の両方に多大な負担がかかります。

必ず最新かつ実際に確認した挙動を元に、マニュアルの解説内容を記載するようにしてください。

 

⑤具体的な説明内容を作成する

実態の確認結果に基づいて、詳細な説明内容を作成していきましょう。

 

説明対象となる操作や機能が、マニュアル上で明確にわかる記載になっているか留意してください。

文章だけの説明には限界があるため、必要に応じて操作画面のキャプチャなど、画像での解説も取り入れましょう。

 

また、詳しく解説をしようとするあまり、マニュアルの説明文が冗長になりすぎてしまうのもよくある失敗です。出来るだけ簡潔な表現を心がけましょう。

 

⑥レビューを行い改善する

詳細な説明内容を記載したあとは、複数人でマニュアルのチェックを行いましょう。

さまざまな観点からマニュアルのレビューを行うことで、必要な説明の抜け漏れや読み手にとって分かりづらいポイントなどに気づくことができます

 

⑦定期的に見直し更新する

マニュアルは一度作成して終わりではありません。

マニュアルを閲覧したユーザーからの声を反映したり、サービスの機能追加や改修に応じて説明内容を更新したりするなど、定期的なアップデートが必要です。

 

古い内容が書きっぱなしになっているマニュアルは、かえってユーザーの混乱を招きます

マニュアルをユーザーサポートに資する効果的なものにするためには、適宜更新を忘れないようにしましょう。

サービスの内容に変更が生じた場合はマニュアルの更新もセットで行えるよう、必要な作業としてTODO化しておくことをおすすめします。

 

わかりやすいマニュアルを作成するためのポイント

ここからは、マニュアルをユーザーにとってわかりやすいものにするために、特に気をつけるべき6つのポイントについて解説します。

 

マニュアル作成のポイント

マニュアル作成のポイント

 

①検索性を担保する

情報がどれほど詳しく網羅的に書かれているマニュアルであっても、ユーザーが知りたい内容を見つけられなければ意味がありません

ユーザーにとって使いやすいマニュアルにするためには、内容の充実のみならず、検索性の担保が重要なポイントです。

 

マニュアル内のどこにどんな情報が記載されているかひと目でわかるよう、目次を整備しましょう。

また、各項目のタイトルは一定のルールに基づいてつけるようにすると効果的です。

 

②曖昧な記載を避ける

マニュアル内に多義に解釈できたり解釈に迷ったりするような記載が多い場合、マニュアルを読んだユーザーが逆に混乱してしまう事態を招きかねません。

 

曖昧な記載を避けるためには、以下のような観点で作成したマニュアルをチェックしてみましょう。

・5W1Hが明記されているか?

・サービス内で使われている用語と同じ用語を使っているか?

・マニュアル内で表記の揺れがないか?

・マニュアル内に指示語(それ・あれ)が多すぎないか?

・画像を用いて説明したほうが、対象を特定しやすい箇所はないか?

 

③操作に必要な情報を網羅的に記載する

操作や機能を利用する前提となる条件も含めた必要な情報を、マニュアル上で網羅的に解説できているかチェックしましょう。

サービスの提供側からすると当たり前に感じられる条件であっても、ユーザーがそれと同じ感覚を持っているとは限りません

ユーザーがサービスを利用する環境は十人十色であり、リテラシーもさまざまです。

 

④マニュアルのボリュームや見やすさに配慮する

説明を充実させればさせるほど、比例してマニュアルのボリュームも増えていきます。

あまりにマニュアルの分量が多すぎると、それだけでユーザーの見る気が失せてしまいかねませんし、知りたい情報を探すのも大変になってしまいます。

必要に応じてマニュアルを分割したり、図表を用いてメリハリのある表現を用いたりしましょう。

説明の詳しさだけでなく「閲覧しやすさ」も確保することがポイントです。

 

⑤ユーザーや操作を知らないメンバーにチェックしてもらう

すでにサービスの内容をよく知っている方の場合、多少マニュアルに分かりづらい点や説明の抜け漏れがあっても、頭の中で情報を補って読んでしまい違和感に気づけないことがしばしばあります。

しかし、マニュアルを実際に使うのは、サービスに詳しくないユーザーです。ユーザー目線でマニュアルに不備や不足がないかチェックするためには、実際のユーザーからレビューを受けることが最も効果的です。

ユーザーの協力を得ることが難しい場合は、解説対象の機能や操作をよく知らない社内メンバーにレビューを依頼してみましょう。

 

⑥運用しながらブラッシュアップする

ユーザーに使ってもらうまで見えてこないマニュアルの改善点は、必ずあるものです。

もちろん、誤った記載がないかチェックする必要はありますが、最初から完璧なマニュアルにしようとこだわりすぎないようにしましょう。

初版の完成度を追求するより大切なことは、ユーザーの声をキャッチし、それを速やかにマニュアルへ反映していける仕組み・体制の整備です

 

まとめ

この記事では、ユーザーサポートに役立つマニュアル作成の基本をご紹介しました。

適切な手順を踏むことで、手戻りや抜け漏れを最小限にしつつ、効果的なマニュアルを作成することができます。

 

扱うサービスやターゲットユーザーの特徴によって、最適なマニュアルのあり方はさまざまです。

自社サービスの進化やユーザーの声へキャッチアップしながら、マニュアルの作成・運用を行いましょう。

 

サービス全体を網羅的にサポートするツールとして、マニュアルは非常に有効です。

ただし、情報量の多さゆえにユーザーが知りたい情報を探すのに時間がかかったり、作成側にもある程度の工数を要したりするという面も持ち合わせています。

機能や操作方法をピンポイントかつサービスの操作中に説明できるチュートリアルをマニュアルと組み合わせることで、デメリットを補いあいより効率的なユーザーサポートの体制を整えていきましょう。

 

【Onboarding】 -株式会社STANDS

Onboarding(オンボーディング)は、ウェブサービスにユーザーを導くガイドを設置するUI/UX改善ツールです。

エンジニアのリソースを使わず、ノーコードで簡単にチュートリアル、ヒントなどのガイドを作成することができます。ユーザー属性や利用状況を分析し、データをもとにした施策を実行・改善といった、PDCAに必要な機能をワンストップで提供しています。

▼サービスページ
Onboardingサービスイメージ

【STANDS編集部】
日々の業務で活用いただける実践的なフレームワークや、
知っておきたいSaaSのトレンドワード・キーワードの解説、
CS業務改善のためのヒントなどをお届けいたします。

資料請求フォーム

一覧へ戻る