こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
運用マニュアルのテンプレートと例文をご紹介します。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
運用マニュアルとは？
システムを運用する際にオペレータ向けに用意されるのが運用マニュアルです。業務に伴ってシステムの操作を必要とする場合、運用マニュアルを読み進めながら行うことで、ミスなく業務を遂行できます。
ヘルプドキュメントは問題が発生した際に読まれますが、運用マニュアルは問題が発生しないために読み進められる文書になります。
運用マニュアルの目的
業務に不慣れであったり、複雑なシステム操作が伴う場合、ヒューマンエラーが発生しやすくなります。あらかじめ手順を明記しておくことで、そうしたミスの発生を防げます。それが運用マニュアルの役割です。
そのため運用マニュアルはシステム全体を網羅したヘルプドキュメントとは異なり、特定の業務を行うのに特化した形で作成されます。
運用マニュアルの書き方
運用マニュアルで含まれるべき内容です。
タイトル
操作マニュアルの名称です。
概要
この運用マニュアルに関する説明です。どういった操作を行う目的で書かれているのか明記します。たとえばバックアップマニュアルなどとしてしまうと、サーバーごとに異なる操作があった時に分かりづらくなります。そうしたオペレータの読み違いを防ぐ上でも、適切な概要記述が求められます。
操作計画
この運用マニュアルが利用されるべきタイミングを明記します。バックアップと言っても日次や月次などによって取るべきデータが異なるでしょう。オペレーターが間違えないように明記しましょう。
処理ごとに記述
複数のシステムやハードウェアなどにまたがる場合には、以下を繰り返して記述します。
対象システム
ハードウェア、ソフトウェアを明記します。
処理内容
必要な処理内容を記述します。なるべくスクリーンショットや写真を用いて、オペレーターがスムーズに作業できるようにします。
注意点
操作を行う上での注意点があれば明記します。よくあるエラーとその対処法も記述しておくと良いでしょう。
関連資料
別な操作マニュアルや別資料を参照する必要がある場合に明記します。
障害対応
操作を行う前後で障害が発生した場合の対応を記述します。
問い合わせ先
システム部門の担当者や、外部の協力企業などの連絡先を明記します。
必要な情報
問い合わせる際にあらかじめ用意しておくべき情報を記述します。単にエラーが出ました、では原因究明に時間がかかり、結果としてサポートが得られません。問い合わせる際に必要な情報を明記しておくことで、オペレーターは事前に情報を収集できます。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
運用マニュアルのサンプル例
##タイトル
会計システム月次締め処理操作マニュアル
##概要
本操作マニュアルは会計システムの月次締め処理に関する操作を解説します。
##操作計画
本操作は毎月10日までに実行されます。締め処理は会計担当者が実行した後、バックアップ操作をシステム部門にて行います。
##操作
###会計システム
会計システム担当者の操作になります。
####処理内容
- 会計システムへログイン後、管理メニューより月次締め処理へ進んでください。
- 月次締め処理実行ボタンを押します。
- 確認ダイアログが出ますので、確認ボタンを押してください。
- 月次締め処理が実行されます。完了ダイアログが出るまでお待ちください。
- 完了しましたというダイアログが出たら、システム部門にその旨ご連絡ください。
####注意点
- 締め処理を行うには会計担当者の権限が必要になります。権限がない場合には管理画面に月次締め処理は表示されません。
- 処理を途中で止めた場合（OSが落ちた場合など）は、再度1から操作をやり直してください。
####関連資料
会計システム全般の操作については会計システムヘルプドキュメントを参照してください。
###ハードウェア
会計システムで月次締め処理が完了したら、バックアップを取ります。これはシステム部門の担当者が実行します。
####処理内容
- 会計サーバーへSSHでログインします。
- backup.shを実行します。バックアップ処理はおおよそ30分かかります。サーバーからはログアウトしても大丈夫です。
- 処理が完了（またはエラーになったら）したらメールが送信されます。
- バックアップサーバーにSSHでログインします。
- バックアップファイルが作成されているのを確認します。
####注意点
- backup.shの実行権限がない場合、実行時にエラーになります。
####関連資料
特になし
##障害対応
###問い合わせ先
会計システムの月次締め処理でエラーが発生した場合には、株式会社会計システムのサポートセンターへ問い合わせをしてください。平日9:00〜18:00、電話番号は000-000-0000です。問い合わせする際には顧客ID AAAAAを利用します。
###必要な情報
問い合わせを行う際には以下の情報を用意しておくとスムーズです。
- 発生したエラーID
- 表示されているエラーメッセージ
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/
