Effective manual creation

効果的なマニュアル活用法

-すべてのナレッジを価値に変える-

システム運用マニュアルとは？具体的に記載すべき内容から継続的に使用してもらうポイントまで徹底解説

2023/01/26

システムが安定的に稼働し、システムを使うエンドユーザーがスムーズに入力や照会を行い、もし小さなトラブルが発生しても早期に解決している――。これはまさに、システムの運用担当者の努力の賜物です。

システムの企画や開発と比較すると目立たない存在かもしれませんが、システム運用業務はエンドユーザーとの接点も多く、業務品質を保ち安定した取り組みが継続して求められる重要な業務です。そのため、知見を共有し運用業務のバラつきを防ぐマニュアルをどう作成するかは、大切な課題です。

この記事では、システム運用マニュアルの具体的な内容や、マニュアルを作成する際に留意すべきポイントについてご紹介します。

＜業務マニュアルクラウドツールをお悩みの方へ＞: 業務マニュアルをクラウド化することで
どのようなメリットが得られるのか、
『業務マニュアルをクラウド化するメリットとは？』: ～業務マニュアルクラウドツールをお悩みの方は必見！～; 資料ダウンロード

システム運用マニュアルとは？

システム運用マニュアルとは、システムの概要や設計、操作方法や障害発生時の対応などシステムに関する内容や、運用業務内容、システムを使用するエンドユーザーの業務内容など、システム運用に関する手順をまとめたものです。

システム運用の業務は多岐にわたり、運用統制（運用に関するルールの策定や監査対応など）、業務運用（システム更新、権限管理など）、システム監視やバックアップ、ヘルプデスク（操作問い合わせ対応）などがあります。

どのようなシステムであれ、運用に関するマニュアルは必ず整備され、広範な知識の正確な理解が求められます。万が一マニュアルの更新が追いついていないと、新任担当者が必要な知識を得られず、トラブルの解決に時間がかかったり、誰もトラブルを解決できずシステムがブラックボックス化したりするおそれもあります。

しかし、運用に関するマニュアルの種類やボリュームが多いため、マニュアルのレベル感がまちまちになったり、更新作業に手間がかかったりしている状況もあるのではないでしょうか。長く活用していけるマニュアルを作り、マニュアルの管理体制を構築することが求められます。

システム運用マニュアルの4つの種類

システム運用マニュアルは、システムの数やシステム部門の規模によって企業ごとに違いがありますが、おおまかには次の4種類に分けられます。

設計、仕様マニュアル
運用業務マニュアル
エンドユーザー業務マニュアル
障害対応マニュアル

どのようなマニュアルなのか、見ていきましょう。

設計、仕様マニュアル

１つ目は、システムの設計や仕様に関するマニュアルです。

システムを開発した部門や企業から、基本設計や詳細な機能についての資料を受領し、それをマニュアル化したものです。

運用はシステムが完成したあとの業務ですが、そもそもシステムがどのような構造で作られているかを理解しないと、問題が起こったときにスムーズに調査できなくなります。そのため、どんな設計に基づいて開発されたのか、どんな仕様で完成しているのかを記載した資料を入手し、マニュアルにします。

自社で開発を行っている場合は、いつでも開発担当者にヒアリングできますが、社外で開発したものを購入している場合は、システム導入時に入手した資料を社内で共有する必要があります。

運用業務マニュアル

２つ目は、運用担当者の業務マニュアルです。

システム運用には、運用全般を管理する運用統制業務や、システム監視などの運用業務があります。

運用統制業務には、運用方針の策定やリソース管理、システムを利用するエンドユーザー部門や経営層など関係部署とのリレーション、運用計画立案、関係省庁による監査対応など、運用の方向性を決める業務があります。

運用業務には、日次、週次、月次での作業やアクセス権などのセキュリティ管理、ライセンスの管理、システムの性能監視やバックアップ、テストの実施など、システムを安定的に稼働させる業務があります。

この他に操作の問い合わせなどに対応するヘルプデスク業務があれば、問い合わせ対応のためのマニュアルも整備されます。

エンドユーザー業務マニュアル

3つ目は、エンドユーザーの業務マニュアルです。

エンドユーザーとは、そのシステムを実際に業務で使用する従業員を指しており、例えばシステムを使って取引を入力したり、顧客の取引状況を照会したりする従業員のことです。

エンドユーザーの業務において、どの場面でどの機能を使用するのか、どんな操作を行うのかはシステム運用担当者の操作とは異なりますから、エンドユーザーのシステム使用方法を把握する必要があります。例えば、エンドユーザーがある取引を大量に入力したときにシステムに負荷がかかり、運用業務に支障が発生した場合、原因を調査するためには、システム運用担当者はエンドユーザーのシステムに関わる業務を知っておく必要があります。

システム開発担当者がエンドユーザーに、導入当初にシステムの使用方法についてのマニュアルを渡している場合はそれがエンドユーザー業務マニュアルになります。エンドユーザーがさらに追記して詳細な業務マニュアルにしている場合は、それをシステム運用担当者が受け取る場合もあります。

障害対応マニュアル

４つ目は、障害対応マニュアルです。

システム運用においては、平常時と障害発生時の2つのケースを想定しておく必要があります。前述した「運用業務マニュアル」や「エンドユーザー業務マニュアル」は、いわば平常時の業務について記載したものであり、障害発生時は別の内容となりますので、障害対応については別マニュアルとしている企業が多いでしょう。

障害対応マニュアルでは、システム障害が起きた時の初動や原因調査、復旧対応や復旧後の対応などの障害発生時の手順について説明します。また、障害発生を検知した際の関係者の連絡先や、影響のあるバッチ処理などの運用作業スケジュールも記載し、いざ障害が発生したときに迅速に対応できるように備えたものです。

システム運用マニュアルを作成する5つのポイント

システム運用に関するマニュアルは、システムの数がたとえ少なくても前述したようなマニュアルが必要となりますから、システム数が多くなればなるほどボリュームが増えて、マニュアルの作成や管理は大変になります。

そこで、マニュアル作成の負荷を減らしつつも、業務に役立つ使い勝手のいいマニュアルを作成するポイントを5つご紹介します。

運用ポリシーを明記する
新人目線で作成する
周辺知識も盛り込み使用者の理解を促す
障害対応マニュアル
完璧に作りこまないでスモールスタート

1.運用ポリシーを明記する

運用ポリシーをマニュアルに明記しましょう。

運用ポリシーとは、システム運用に際して自社で決めた方針のことです。具体的には、サービスレベル管理（システム部門とエンドユーザー部門とで合意するもの）、セキュリティ管理（マルウェアなどの脅威対応）、サプライヤー管理（システム導入を担当する企業との契約対応）などについて、管理の目的や何をどこまで行うのか、といったことを定義するものです。

また、このポリシーに基づき、運用の範囲や権限などを具体的に定めた運用ルールも策定している企業が多いでしょう。運用ポリシーや運用ルールは、運用対象のシステムが何であれ共通する内容ですから、常に意識できるよう運用業務マニュアルに盛り込むようにしましょう。運用業務マニュアルを担当ごとやシステムごとに分けている場合は、それぞれに同じ内容を挿入します。

システム運用業務は関係部署が多い業務ですから、細分化された業務を担当していると、つい目的を見失い、何をどこまでやるべきなのか対応範囲に迷う場面も出てきます。システム運用担当者一人ひとりが意識して業務に取り組めるよう、マニュアルにはポリシーやルールを明記しておきましょう。

2.新人目線で作成する

新人目線でマニュアルを作成しましょう。

マニュアルを作成するのは業務に精通した担当者であることが多いものですが、マニュアルを一番よく使うのは業務に詳しくない担当者です。つまり、新入社員や異動したての新任担当者などです。マニュアル作成者が常識のように持っている知識は、まだ新任担当者は持っていないと想定し、専門用語には解説をつける、できるだけ一般的な用語で説明する、などわかりやすいようにマニュアルを作成しましょう。

システム運用は、システム開発に携わった担当者が異動してきて運用を担当するケースもありますが、開発に携わった人は内容の充実したマニュアルを作成できるメリットがある一方で、携わっていない人の立場に立ちにくい面もあります。マニュアルを作成する際は、システム開発に携わっていない人が読んでみて、新任担当者にわかるかどうかをチェックするようにしましょう。

5W1Hを意識してマニュアルを作成すると、「誰が」「誰に」など、無意識に省いてしまう情報を漏れなく言語化できます。

3.周辺知識も盛り込み使用者の理解を促す

マニュアルには、周辺知識も盛り込み使用者の理解を促しましょう。

周辺知識とは、業務の目的や背景、経緯、理由など、その業務にまつわる情報のことです。マニアックなシステムについての知識ということではなく、「なぜこの業務が必要なのか」「どうしてこのやり方をするのか」といったことが深く理解できるような知識です。

特にシステム運用の業務においては、手順でミスをするとシステムがフリーズしたり、重大なインシデントにつながったりするリスクがあります。手順の重要性、過去にあった失敗事例や、別の方法での成功事例など、必要なナレッジは運用担当メンバーで共有し、後の人へ承継していく意識が大切です。

4.図表を入れ視認性のよいマニュアルにする

図表を入れ、視認性のよいマニュアルにしましょう。

文字による解説だけでなく、図表やイラストを入れると直感的に内容をつかめるマニュアルになります。他にも、チェックリスト形式を取り入れる、動画を挿入するなどの工夫をすると、作業ミスの防止につながります。画面遷移やキーボードなどを文字で説明するよりは、スクリーンショットや写真の形でマニュアル化する方がわかりやすいですし、作成や更新時の負担軽減になるでしょう。

また、業務の流れや、社内におけるシステム運用業務の位置づけをフロー図にすることで、業務の全体像や関係部署との連携を把握しやすくなります。

5.完璧に作りこまないでスモールスタート

完璧に作り込まないでスモールスタートしましょう。

「マニュアルを完璧に作らないと業務開始できない」とばかりに完璧を目指して作っても、あとから改善点が見つかったり、変更点が出てきたりするものです。マニュアル作成者は、知識や情報をできるだけ詳しく記録することに意識が向くものの、業務をやりながら閲覧してみると、端的に短文で書いてある方が使いやすい場合があるからです。また、マニュアル作成に時間をかけている間にシステムのバージョンが変わり、書いていた内容がもう変更になってしまった、というケースも出てきます。

まずおおまかなベースを作り、業務を行いながら完成させていくことで、実務に即したマニュアルになります。また、この方法では、業務と平行しながらマニュアルの内容を更新していく流れを作ることにもなるので、おすすめです。

システム運用マニュアルは定期更新が重要

前の章では、作成の負荷を減らしながら使いやすいマニュアルを作成するためのポイントをご紹介しました。マニュアルは「一度は作成したものの、更新が追いついていない」といった状況に陥りがちですので、マニュアルをシンプルに作ってスモールスタートし、業務状況を見ながら更新して完璧なものに近づけていくと、作成も更新も大きな負担にならずに、最新の状態を保てるでしょう。

更新を負担なく行っていくためには、マニュアル作成時に以下のことを決めておくことが大切です。

更新する担当者（どの担当者がどのマニュアルを更新するのか）
更新時期（随時の更新と定期の更新）
更新方法（担当者が更新し管理者が承認するなどの流れ）

更新時期については、業務に変更があった際や事例を追加したいとき随時に行い、そのほかに年に1回～2回は業務繁忙期を避けて定期的に行うと、更新すべきものを漏れなくすくいとることができるでしょう。システム自体のバージョンアップがない時期でも、例えば日常業務で発生した想定外のトラブルや、テストの結果見直すこととなったリカバリー手順などがあれば、マニュアルを更新していく必要があります。

お役立ち資料：『『業務マニュアルをクラウド化するメリットとは？』～業務マニュアルクラウドツールをお悩みの方は必見！～』