はじめに
システムの操作マニュアルを求める声が顧客や社内から出ている、分厚いマニュアルはあるが読んでもらえないなど、マニュアルが整備されていないとさまざまな課題が発生します。
本記事では「操作マニュアルの作り方を知りたい」「誰もがわかる簡易マニュアルを作成したい」という方に、操作マニュアルの作成手順や筆者が実際にマニュアル作成に携わった感想やコツなどをお伝えいたします。
ぜひ作成手順やコツを知っていただき、自社のマニュアル作成に活かしてください。
操作マニュアルとは？
操作マニュアルは、システムやツールの操作方法やトラブルの対処方法などを確認するためのドキュメントです。
操作マニュアルを作成するメリットとしては、意図しない事故や業務の属人化を防ぐことが挙げられます。
新入社員や新任の担当者など、システムを使用したことがない初心者が読むことを前提に作成します。
操作手順が省略されていたり、操作後の結果が記載されていなかったりすると、「正確な操作ができない」「手順が合っているのか分からない」といった問題が発生します。
操作マニュアルでは、操作の目的・手順・操作後の結果を理解しやすく記載されていることが大切です。
次項から操作マニュアルの作成手順をご紹介します。
操作マニュアルの作成手順
操作マニュアルの手順は以下の通りです。
- 対象者を決める
- 記載する内容を洗い出す
- 構成を考える
- 原稿を作成する
1. 対象者を決める
操作マニュアルを読む相手を決めましょう。
対象者のシステムの理解度や経験値によって、使用する用語やマニュアルに記載する内容は変わります。
また対象者を明確にすることで、複数人でマニュアルを作成する際の共通の指針ができます。
2. 記載する内容を洗い出す
説明が必要な操作項目をすべて書き出しましょう。後から記載する項目が増えると、構成や原稿の修正などの工数が膨らみます。
また経験のある社内スタッフやシステムのサポート担当者にヒアリングを行うことも重要です。
3. 構成を考える
記載内容を項目ごとに分けたり、掲載する順番を決めましょう。
構成を決めないまま本文を作成してしまうと、内容の抜け漏れや重複が発生する原因となります。
またマニュアルのレイアウトも考えておきましょう。使用するフォントやサイズ、色、表記ルールなどを決めます。
大見出し、中見出し、本文など原稿のフォーマットを決めておくと、原稿作成の作業が効率的に進められます。
マニュアルに目次やQ&Aを載せるのもよいでしょう。
4. 原稿を作成する
構成が決まったら、原稿作成に取り掛かります。誰もが理解できる原稿を作成できるように意識しましょう。
原稿作成のポイントは以下の通りです。
- 一つ一つの操作手順は省略せずに書く
- 操作の目的や操作後の結果を書く
- 冗長な表現や接続詞など、文中に無くても意味が伝わる言葉は使わない
- 箇条書きや太字などを使い文章にメリハリをつける
- 図表やイラストなどを使い視覚的に読みやすくする
【実録】操作マニュアル作成の体験談を大公開
簡単に操作マニュアルの作成手順を解説しました。ここからは筆者のマニュアル作成の体験談をお伝えいたします。
手順は分かったけど、より実践的な内容を知りたいという方もいるはずです。
苦労した点や反省点など、これからマニュアル作成に関わる方の参考になれば幸いです。
操作マニュアル作成の経緯
筆者の会社では「WisdomBase（ウィズダムベース）」というeラーニング環境を構築できるシステムを提供しています。
社内教育のオンライン化や、オンライン講座の販売プラットフォームとしてご活用いただいています。
WisdomBaseの導入支援として、カスタマーサクセスチームによる操作説明などのオンボーディングを行っています。しかし、ミーティングですべての操作を把握することは難しいという課題や、簡易なマニュアルがほしいという声をお客さまからいただいていました。
そこで、導入支援のミーティング以外でも操作を確認できる環境を、WisdomBaseで構築しようというプロジェクトが立ち上がりました。
カスタマーサクセスチームからのヒアリング
マニュアルの対象者はオンボーディング中のお客さまです。オンボーディングで説明している内容をマニュアル化するという方向で決まりました。
まずはカスタマーサクセスチームやカスタマーサポートチームからオンボーディング内容についてヒアリングをしました。
何度かの聞き取りの中で以下のことが判明しました。
- お客さまの利用目的によって複数のオンボーディングのパターンがある
- 共通で説明している機能と、特定のユースケースのときだけ説明している機能がある
オンボーディング内容をそのままマニュアル化すると膨大な情報量になるため、マニュアル化する内容について項目の取捨選択が必要でした。
企画・構成を決める
企画・構成やフォーマットの作成、進行方法など決めることがたくさんあります。
プロジェクトを前に進めるために、方向性をチームの中ですり合わせるのが大変でした。
まずはヒアリング内容から構成について他のメンバーと打ち合わせをします。
オンボーディングのガイドラインはありましたが、具体的にどの機能や設定項目について説明しているかは不明瞭でした。
そこで、目的別に機能や設定項目に対して説明可否のチェックリストを作成し、カスタマーサクセスチームに確認をお願いしました。
次にオンボーディングの流れに沿って構成を決めました。
WisdomBaseでは「コース」「セクション」「レクチャー」という単位でコンテンツを管理できますので、何を「コース」とするのか、またコースの中でどのように「セクション」や「レクチャー」に振り分けるのか決めます。
またテキストや動画など、何の形式でマニュアルを作成するのか決める必要がありました。
構成については原稿作成中も調整しましたが、最終的には利用目的別に6パターンの組み合わせになりました。
またそれぞれのパターンごとに構成を組み、テキストと動画の両方でマニュアルを作成する方向に決まりました。
以下は6パターンある中の内の1つの構成表です。
操作方法の確認
マニュアルの作成で苦労したことの1つとして、操作手順を理解することが挙げられます。
使用目的や機能の設定方法、操作を行った結果などを理解していないと、構成や原稿を考えることができません。
操作方法の確認は、原稿作成や動画作成などすべての工程で何度も行ないました。
原稿作成
構成やフォーマットについて社内の承認が得られましたら、原稿作成に取り掛かります。
原稿作成についてもいきなり本文を作成するのではなく、大見出しや中見出しなど文章の構成を決めました。
見出しの実例
- 【大見出し】レクチャー設定の画面構成
- 【中見出し】 セクションの作成方法
- 【中見出し】レクチャーの順番を変更する方法
- 【大見出し】レクチャーの新規作成
- 【大見出し】レクチャー編集ページの設定項目
- 【中見出し】受講可能条件を設定する方法
- 【中見出し】レクチャーIDの確認方法
関係部署に見出しの順番は問題ないか、抜け漏れはないかを確認し、承認が得られれば本文を作成します。
原稿作成のツールはGoogleドキュメントを使用しました。原稿チェックの際に修正提案やコメントが残せるためです。
ここで気をつける点は、マニュアル全体で表記を統一させることです。
例えば、「Webブラウザ」「ウェブブラウザ」「WEBブラウザ」とさまざまな表記があります。
しかし表記がバラバラだと、内容を理解する上で読み手にストレスを与えますし、誤字に受け取られる場合もあります。
読み手が内容を理解をすることに集中できるように、余計なノイズは減らすことが大切です。
またシステムの操作を文章のみで内容を理解するのは至難の業です。
操作画面をスクリーンショットし、操作手順と画像をセットで作成しました。
動画作成
構成テキストのマニュアルの中に動画のマニュアルも埋め込みました。
映像として操作手順を確認できる方が、実際の運用をイメージでき理解が早まるからです。
テキストは後で見直したり知りたい箇所だけ見るなど、用途に応じて使い分けられるようにしました。
コンテンツ公開作業
原稿や動画がすべて完成しましたら、公開作業を行ないます。
Googleドキュメント上のテキストをシステムに反映させ完成です。
実務を通して感じたマニュアル作成のポイント
最後にマニュアルを作成する際に決めておいたほうが良いことや、気をつけるポイントについてお伝えいたします。
- 誰がどの場面で、どのように使用するマニュアルであるか決めること
マニュアルの作成手順でもお伝えしましたが、マニュアルを使用する対象者や使用するシーンを関わる人全員に共有しましょう。
関わる人の多さに比例して、さまざまな意見が出てきます。対象者や使用目的を基準として情報の取捨選択をしましょう。 - 表記ルールや原稿・動画作成のルールを作成すること
複数の人が原稿や動画作成を担当すると品質に差が生まれます。
表記の仕方が違ったり、図表やイラストのテイストが違ったりすると仕上がりに影響があるため、ルールを明文化しておきましょう。 - 全体の構成や原稿の内容など、各関係者にこまめにチェックすること
後から構成の一部を入れ替えたり、原稿の修正があったりすると、指摘箇所は些細な内容だとしても、全体の整合性を保つために複数箇所を修正しなければならないという場合が多々あります。
工数が膨らむ要因ですので、細かく方向性を確認しておくとスムーズに進行できます。
まとめ
本記事ではシステムの操作マニュアルの作り方と、マニュアル作成の体験談をご紹介しました。
実際に体験して言えることは、操作マニュアルの作成は時間と手間が想定以上にかかるということです。
しかし、間違った操作によるトラブルや問い合わせ対応にかかる時間などを鑑みると、マニュアルの整備は価値のある業務だと思います。
今回の記事が操作マニュアルの作成をする担当者の方のお役に立てれば幸いです。
顧客サポートや社内教育の強化に！eラーニングで業務効率をアップしませんか
本記事でご紹介しましたWisdomBaseは、eラーニング環境を構築できるシステムです。
動画やテキスト、PDFなどさまざまな形式に対応しており、顧客や社内スタッフのサポートや育成を強化します。
人によるサポートだけでは手が回らない、デジタルを活用しコストカットしたいなど業務効率化としても活用いただけます。
導入事例「マニュアル動画の配信により問合せが減少。カスタマーサポートを大幅に効率化できました」wisdombase.share-wis.com
サービスに関するお問い合わせはこちらからwisdombase.share-wis.com
