運用マニュアルとは?運用マニュアル作成で重要な5つのポイント

運用(操作)マニュアルとは?

まずは「運用(操作)マニュアル」というものの定義を説明しておきますね。

運用(操作)マニュアルとは「手引書」のことであり、
そこにはPCシステム等の「使い方」、「問題が起きたときの対応方法」、「気を付けるべきこと」などが細かく記載されています。

基本的には「提供する側」が運用(操作)マニュアルを作ることになりますが、「利用する側」と協力して「使う環境」に沿った運用(操作)マニュアルが作り上げられる場合もあります。

一言で表現すると「運用(操作)マニュアル=説明書」ということですね。

運用(操作)マニュアルを作る際の要点5つ

では運用(操作)マニュアルを作るときにはどのような事に注意すべきなのでしょうか。

1:「使い勝手」を追求する-目的・全体像が理解できる運用(操作)マニュアルにしましょう

システムを使う際には、色々な分岐が生じるものです。
「Aという状況になったら○○をする」
「Bという状況になったら××をする」
などですね。

運用(操作)マニュアルのこの部分の書き方が悪いと、どこで何をすればいいのか理解できなくなります。

ですから、最初に全体のシステムフロー図を完成させ、そこに「作業」と「分岐」を書き入れていきましょう。そうすれば「このアクションは、全体の流れにおいてはどこに位置するのか」ということが把握できるようになります。
作業別にナンバリングをして、その番号に従って運用(操作)マニュアルを作れば、フロー図が目次になるので、より分かりやすい説明書になりますよ。

運用(操作)マニュアルに入れておきたい項目としては、

  • アクション番号とそのアクションの名前
  • アクションのタイミング
  • アクションをする人の名前
  • アクションの目的
  • 前提条件
  • 事後条件
  • 参照資料
  • 関連作業番号

などです。
さらに「アクション手順(作業フロー)」と使うシステムの名前、アクションに関する注意事項を組み合わせてフォーマットにしておくと役立ちます。

2:細分化して検索しやすくしましょう

全体のフロー図が必要になるような運用(操作)マニュアルでなくても、目次がなければ検索しにくくなってしまいます。

ちなみに、運用(操作)マニュアルは無理に一冊に抑えなくてもいいです。
膨大なボリュームになるのでしたら、種類別に数冊に分割するなどして使い勝手を良くしましょう。

さらに「この作業の詳細は他のマニュアルに~」という場合は、関連アクションを近いページに置いたり、その作業番号を書いたりしておくと検索性がアップします。

大事なのは「実際にユーザーがその運用(操作)マニュアルを使う流れを想定して、見やすさや検索性を上げるための工夫をする」ということです。
想像力を働かせましょう。

3:シンプルに~「ユーザーにとって」理解しやすくまとめる~

  • 専門用語を使い過ぎる
  • 文章が長く説明がしつこい
  • 文章だけで手順を記載する(図や画像がない)

などの運用(操作)マニュアルではユーザーは理解できません。

文章での解説だけでなく図や画像も使い、現実の操作を想像することが可能な「見える」運用(操作)マニュアルに仕上げましょう。
運用(操作)マニュアルは「直感的に理解できる」のが一番です。

ちなみに、近年は運用(操作)マニュアルにムービーでの説明が入る場合も増えています(もしくはムービーのみ)。
「理解しやすさ」へのニーズがより強くなっているということなのかもしれませんね。

4:疑問点・トラブルを予想してカバーする

運用(操作)マニュアルの中に「よくある質問(Q&A)」を入れてください。
一般ユーザーでも思いつくようなQ&Aも必要ではありますが、それだけでは足りません。
問題が起きやすいアクションなどに関しては、「実施上の注意点」を運用(操作)マニュアルのフォーマットに入れておき、そこでトラブルを解消できるようように仕上げておきましょう。

特に別のシステムと組み合わせて操作したり、ややこしい操作をしたりする場合は、運用(操作)マニュアルを何度もハイペースで確認することになります。
ですから、アクションをミスした際の修正の仕方の説明も近いページに載せておきましょう。

5:更新しやすい運用(操作)マニュアルを!

ある意味では、運用(操作)マニュアルには「完成」という概念がないとも言えます。
なぜならシステムのアップデート・変更・追加があった際には、運用(操作)マニュアルの更新を行わなければならないからです。

同じ運用(操作)マニュアルをずっと使うのであれば、ユーザーが「ここはこうすべき」などと思ったタイミングで赤入れして、1年に1回程度更新するというような手段もあります。

更新を怠ると「運用マニュアルに書いてあるシステム」と「実際のシステム」にズレが出てきてしまい「運用(操作)マニュアルを確認しているのに、この図面が出てこない!」といった事態に陥ってしまう恐れがあります。

運用(操作)マニュアルはシンプルなフォーマットで仕上げて、アクション別にファイル(ページ)を分けるなどして、更新をしやすくしておきましょう。
運用(操作)マニュアルには適度に図形などを入れるべきですが、過剰に入れると更新に手間取ることになってしまうので注意が必要です。

最後に

運用(操作)マニュアルには完成はなく、常に更新が必要なことまでお分かりいただけたと思います。
ですが、自分たちだけですべてカバーしていくにはマンパワーも時間も足りない!ということもあるかもしれません。そんなときにはプロのマニュアル作成会社に外注することも手です。コストはかかりますが、プロだからこそできる高品質なマニュアルを新期作成から保守管理まで任せることができるので、おすすめです。
マニュアル作成会社によっては、すでにあるマニュアルをベースに改訂作業を引き受け、なおかつそのマニュアルのその後の保守管理も受けることが可能です。
お困りのことがございましたら、ぜひクレストコンサルティングへお気軽にご相談ください。

マニュアル作成費用は内容などにより異なります。お気軽にお問い合わせください。