システムの操作時には、「こういう場合にはこの作業を行う」といったように、多岐にわたる分岐が発生します。

そのため、操作マニュアルに記載されている作業内容が、どのパターンのときに、何のためにやることなのか、分からなくなることが多いのが現状です。


そこで、先に全体のシステムフロー図（概要）を作成し、そこに分岐とアクションを記載しておくことで、全体の流れと操作の位置づけを理解することができます。

その際、アクションごとに番号を振って、その番号に沿って作業手順書を作成していけば、フロー図が目次の役目を果たし、利用者がより理解しやすくなります。


作業手順書に記載する項目には、アクション番号とアクション名、作業タイミング、作業者、作業の目的、前提条件、事後条件、参照資料、関連アクション番号などを設け、実際の作業手順と使用するシステムのメニュー名、作業上の注意事項を1セットとしてフォーマット化しておくと便利です。


また、フォーマットを用意しておくことで他事業部への横展開で合ったり、クライアントへの商品説明にも使用することが出来るので、幅広いシーンで活用することが可能となります。

様々な操作方法や手順をテキストだけで書く、説明が冗長で文章量が多い、専門用語を多用するといった作り方はシステム開発の現場では非常に多いですが、それでは利用者にとって分かりやすいマニュアルとは到底言えません。

言葉での説明に加えて画面キャプチャなどを利用し、実際に操作しているときと同じイメージで操作を行うことが出来るマニュアル作りを心がける必要があります。

直観的に何をすべきかが分かるマニュアルは、知識のない利用者に対しても安心感を与えることができます。


最近では、テキスト形式のマニュアルに加えて、動画によるマニュアルを導入するケースも増えています。

トラブルや疑問点を事前に予測できる範囲で洗い出し、WEBサイトなどでもよく見かけるQ&Aを、マニュアルにも盛り込んでおきましょう。


トラブルになりそうな操作については、作業手順書のフォーマットに注意事項の記載を用意しておき、そこでカバーできるような作り方を意識することで、問い合わせを減らし時間効率の向上にもつなげることが可能です。


システムの運用上、複雑な操作や外部のシステムと連携するケースでは、マニュアルの参照頻度が多くなります。

例えば、作業を間違えてしまった場合のリカバリ方法なども掲載しておくと、利用者にとっては安心することが出来ます。

これまで挙げたことは、1度マニュアルを作成したらそれで終了、というものではありません。

システムの更新時や機能追加・改修があった場合は、当然のようにマニュアルも併せて更新する必要があります。

そうでないと、実際のシステムとマニュアルの中身が乖離し、利用者は不信感を持つようになります。


もし、作成したマニュアルが年間を通じて使用するマニュアルであれば、利用者が気づいたときにマニュアル内にコメントを残していただくことで、年に一度集約するといった方法も効果的です。

先述したようにマニュアルの更新を行わないでいると、次第に現実のシステムとマニュアル上のシステムに乖離が生じてしまい、マニュアルを見ても現状と同じ画面が見つからない、といったことにもなりかねません。


不要なコメント機能や図形を多用しないシンプルなフォーマットでマニュアルを作成し、更新などがあった際に簡単に差し替えができるよう、作業ごとにページを区切るなどの工夫を施し、更新作業を軽減できるように工夫しましょう。

今回は、システム開発の現場でマニュアルを作成する場合のポイントについて細かく解説していきました。

このマニュアルを作成するポイントについては、システム開発の現場以外の職業などでも活用できるテクニックではないでしょうか。


上記でも解説したように、昨今の社員の入れ替わりが激しい世の中では、誰であっても操作が出来る・対応が出来るなどを意識したマニュアル作りを意識することで、属人性の低い組織作りを行うことが可能となります。

属人性が低い。つまり、ベテラン社員であっても、新入社員であっても同様のクオリティを発揮できるという意味です。


この意識を持つことで、システム開発などのIT業界以外でも幅広い対応力を発揮することが出来るので、是非マニュアル作りと併せて覚えておいていただきたい考え方です。


また、今回は、テキストベースのマニュアル作りを中心に解説させて頂きましたが、上記の考え方はテキストベースでなくとも、動画ベースのマニュアル作りにも応用することが可能です。

誰が見ても同様の結果を得られるよう、日々のマニュアル作りを進めて頂ければ幸いです。