Dojoシリーズ
Dojoコラム

コラム

システムマニュアルに記載すべき内容・注意点をおさえて作成しよう!

  • このエントリーをはてなブックマークに追加

新規・既存にかかわらず、業務システムを社内の誰にでも使えるようにしたい場合には、システムマニュアルの存在が不可欠です。では、どのような点に気を付ければ、初心者でも分かりやすいマニュアルを作成できるのでしょうか。

この記事では、システムマニュアルに記載すべき内容と併せて、作成する際におさえておきたいポイントや注意点について解説します。マニュアル作りに失敗しないためにも、ぜひ参考にしてください。

1.システムマニュアルに記載すべき内容とは?

システムマニュアルとは、利用するシステムの概要・仕様や、使用方法について記載した文書(説明書)のことです。

最近では、多くの企業が業務改善や作業の簡便化を図るためにさまざまなシステムを導入していますが、利用できるようにするためには社内教育が必要です。
また、システム使用中に不明な点やトラブルがあることも珍しくありません。

重大なトラブルが発生した場合は担当者に連絡し、対応してもらう必要があります。
しかし、調べればすぐ解決できる疑問やトラブルまで担当者が対処していては、システムの利用者だけでなく、担当者の業務を増やしてしまうことになりかねません。

担当者の負担増という事態を防ぎ、社内の誰もがスムーズにシステムを利用できるようにするためには、誰が見ても分かりやすいマニュアルを作成することが重要です。
マニュアルの作成者は、「マニュアルを使用する人の立場になって内容を考えること」を心掛け、思い違いによるミスがないよう丁寧に作成しましょう。

では、システムマニュアルにはどのような内容を記載すべきなのでしょうか。
特に重要なメニューとして、次の3つが挙げられます。

  1. 操作マニュアル
  2. 業務マニュアル
  3. 障害対応マニュアル

ここからは、これら3つの基本要素について記載すべき内容をご紹介します。
それぞれの内容を作成する際のポイントも併せて確認し、利用者(ユーザー)のニーズを満たすマニュアルを作りましょう。

1-1.操作マニュアル

システムの利用者が操作マニュアルを読もうとするタイミングは、主に「操作手順や操作方法を確認したい時」と「処理した結果を知りたい時」です。
マニュアルを読みながら操作をすることを考え、利用者が操作する画面のイメージ(画面例)と操作手順・操作説明・操作結果を掲載しましょう。

操作マニュアルの構成イメージ

画面のイメージと説明文の順序は、上の記載例のように、操作手順は「画面のイメージ→説明文」といったように、画像を先に掲載すると視覚的に理解しやすいためおすすめです。

一方、操作結果の部分は「説明文→画面のイメージ」とすると流れが掴みやすくなります。全ての画面イメージをきちんと記載すると、初心者でも安心して操作を進められるでしょう。

また、操作手順の説明文と操作結果の説明文は、改行したり空行を設けたりして、段落を明確に分けて記述することが大切です。どこからどこまでが手順で、どこからどこまでが結果かを一瞥して分かるように工夫してください。基本操作は、特に丁寧に記載しましょう。

説明文を作成する際には、主語が「システム」なのか「利用者」なのかを明確にすることも重要です。システムが行う操作は「表示されます」「検索されます」のように受動態で、利用者が行う操作は「選択します」「入力します」のように能動態で表現しましょう。

1-2.業務マニュアル

業務マニュアルとは、業務上のどのポイントで、システムのどの機能を使用するのかといったことを説明するためのものです。業務作業における作業工程の時間軸(業務フロー)に沿って、各時点で使うべき機能を漏れなく挙げましょう。
機能の名称だけでなく、その機能を使うことで可能となる作業の内容も明記してください。

また、操作マニュアルを作成する際と同様に、システムが行う操作と利用者が行う操作が明確に分かるように書きましょう。システム・利用者が行う操作まで漏れなく記載すると、システムの機能をどのタイミングで使用すれば良いか、利用者が判断しやすくなります。
どのような操作を行うべきか分からない場合に備え、操作マニュアルとの連携もきちんと行いましょう。

別の部門の社員も関係する社内業務は、担当者ごとに作業内容をまとめることをおすすめします。
例えば、「発注業務」に製造部門と経理部門が関係する場合は、発注業務をまとめた章に「製造担当者の作業」「経理担当者の作業」とセクションを分けて記載します。
読むべき部分が一目瞭然であり、マニュアルを読む時間も短縮できるでしょう。

分かりづらい業務マニュアル分かりやすい業務マニュアルの違い

1-3.障害対応マニュアル

システムの障害(トラブル)で利用者が困った際に使用する障害対応マニュアルでは、発生した障害の状況から解決策を探し出せるように記述することが重要です。
利用者がスムーズに問題解決できるようにするためにも、想定される障害発生時の状況を説明する文には、以下のような要素を盛り込むことをおすすめします。

【想定している障害を説明する際に盛り込む項目】

  • 障害が発生した際に、利用者が行っていたと考えられる操作
  • エラーメッセージの内容
  • 障害発生時のシステム画面(エラー画面)
  • 障害が発生した際に、システムの操作はどうなっているか

障害の解決方法を記載する場合、解決するために必要な操作手順を丁寧に記載しましょう。
操作の具体的な内容は操作マニュアルに記載があるため、随時参照できるようにきちんと対応させておく必要があります。

また、利用者が自分で解決できない障害についてもマニュアルに記載しましょう。
「システムを管理する社員へ連絡してください」「サービス提供会社に問い合わせてください」といった説明文を、その障害が発生するリスクのあるポイントで記載してください。

 

製品資料ダウンロードバナー

2.システムマニュアルを作成する時のポイント4つ

システムマニュアルを作成している様子

システムマニュアルは、主に「操作マニュアル」「業務マニュアル」「障害対応マニュアル」から構成されています。それぞれに記載すべき内容や、作成する際のコツを解説しましたが、マニュアルを作成する際には、他にもさまざまな点に注意しなければなりません。

ここからは、マニュアル全体を通して気を付けたいポイントや注意点についてご紹介します。マニュアル作成で失敗しないよう、きちんと把握しておきましょう。

2-1.図表を利用し視認性の高いレイアウトにする

システムマニュアルを作成する際には、図表・イラストを積極的に利用し、レイアウトを工夫して視認性を高めましょう。限られた業務時間内でマニュアルの内容をきちんと理解してもらうためには、読み進める気持ちになれるマニュアルを作ることが重要です。

文字ばかりのマニュアルでは読む気力も失せますが、システム画面の画像などの図表を使用すれば、格段に読みやすくなるでしょう。
直感的に分かりやすいレイアウトを採用すれば、利用者も内容を理解しやすくなります。

また、見出しや文書のフォーマットを工夫して視認性を上げることも大切です。利用者が読みたいと思うマニュアルを作成するためにも、図表や効果的なレイアウトなどを上手に活用してください。

2-2.シンプルな説明を心掛ける

マニュアルを作成する際には「丁寧に記載すること」が重要ですが、文書作成時には詳しく説明しようと文章が長くなることや、不要な情報を書いてしまうことも多くあります。

情報の量が多いと読み手が混乱し、マニュアルに記載されている内容を正しく理解できない場合もあるため、操作内容を書く際はシンプルな説明を心掛けましょう。

専門的な知識をもっていない方が読むことを想定し、専門用語の頻繁な使用は避け、重要な内容ほど簡潔にまとめることをおすすめします。

2-3.完璧に作り込まない

システムマニュアルを作成する際には、最初から完璧に仕上げる必要はないということを心に留めておきましょう。システムを設計した時から業務変更があったり、技術者や開発者の想定外の障害が発生したりするおそれがあるためです。

システム導入時に基本的なマニュアルを作成することは重要です。
しかし一般的に、システムは長期間使用されることで改善点や変更が生まれます。あえて完璧に作り込まず、改善点や追加要素などを定期的に修正・編集・更新して、マニュアルを風化させないようにしましょう。

2-4.ナビゲーションツール「Dojoナビ」を使用する

システムマニュアルは冊子や文書ファイル等に資料としてまとめることも少なくありません。しかし、マニュアルに書かれている内容をより効率的に習得してもらうためには、テンダが提供するナビゲーションツール「Dojoナビ」の使用をおすすめします。

「Dojoナビ」はシステムにおける操作の不明点について、システム画面に操作説明(ナビゲーション)を表示させるなどの方法で、利用者を問題解決に導きます。

利用者にとって分かりにくいポイントがあれば、システム上に付箋をデータとして貼ることもでき、プロジェクトのチーム内でのローカルルールなども付箋に登録し、共有することも可能です。
初めて扱うシステムでも、スキルの有無にかかわらず作業手順を誤ったり迷ったりせずに済むというメリットもあります。

「マニュアルを作成する」、「運用管理する」、「マニュアルを読む」、「操作を覚える」、これらのことを行わなくても新しいシステムが利用者に定着するため、システムの運用に関する教育を施す時間的なコストも、大きく削減できるでしょう。

システム操作ナビゲーション「Dojoナビ」について詳しく見る

まとめ

システムマニュアルは、「操作マニュアル」「業務マニュアル」「障害対応マニュアル」の3つの内容が必要です。ここまでで挙げた各マニュアルを作成する時のポイントを押さえ、漏れのないよう丁寧に記載しましょう。

また、簡単操作で操作概要を表示画面で教えてくれる、マニュアル自動作成ソフト「Dojoナビ」の活用もおすすめです。実績と豊富なノウハウをもつ「Dojoナビ」を利用し、業務効率化を図りましょう。

  • このエントリーをはてなブックマークに追加
お問い合わせ 無料
トライアル
資料
ダウンロード
ページ
トップ