ノウハウはすべて記録に残して更新!運用手順書はこう作っていこう!

理想をいえば、使わないに越したことはないけれど、なくて困るのは目に見えている。AEDや消火器の話ではなく、システム運用の手順書のことです。どんな小さな処理でも、手順書は必要です。手順書の整備や維持管理は、システム運用業務そのものと同様に地味ではありますが、だからこそ非常に重要な作業の一つ。そう思えば、命を守る仕組みにも通じるのかもしれません。

システム運用手順書が必要になる場面はさまざまです。社内の開発部署からのシステムの引き継ぎや他社が開発したシステムの運用管理移行、担当者の異動や、中途・新規人材の採用など、いろいろなシーンで、複数の人たちが必要とします。誰にでもわかりやすく、重要な内容が確実に伝わるように、5W1H的なポイントを意識して、読む人が必要な情報をコンパクトにまとめておきましょう。

何を:要約と目次

その書類が何のためのものなのか、要点を120文字程度でまとめておくだけで、読む人が自分にとって必要かどうかをすぐに判断できます。箇条書きを併用するのもお勧めです。
また、目次をざっと眺めれば、大体何が書かれているかを判断するインデックスとして役立ちます。障害発生時の対応手順は、基本的に時系列に書かれているので、具体的な作業のタイムラインとしても把握できます。

何を:システム構成図

文字で説明するよりも、図で示した方が遥かにわかりやすいことがあります。シンプルでも要点を押さえた構成図があれば、全体を俯瞰して、ネットワーク構成や連携などを確認できます。また、図は一度入れておけば十分とは限らず、画面やページをいちいち前後しなくてもいいように、必要な場所へ適度に挿入しておきましょう。

誰が:対象者

その手順書が誰を対象としているか、どのような権限やスキルが必要かも、最初に出しておくのがいいでしょう。

いつ:更新日

内容の鮮度も重要なので、更新は必ず発生します。更新日や、それを基準にしたリビジョンナンバー(例:xxxxx-190501)なども、ルールを決めて付けておきましょう。表紙など、一番目につくところに明記しておくのがお勧めです。

いつ:作業の工数やタイミング

また、実際に作業対象者がスタートしてから、どの程度の時間が掛かることが想定されているのかが示されているのも重要です。どのタイミングで、どういう状態になったら、いつまでに処理をすればいいのか。作業の優先順位や、他の作業との調整、担当者のアサインなどを調整できます。

どこで:各種アカウント情報等

実際に作業する上で必要となるアカウントなどの詳細をまとめておきます。場合によっては、リモートではなくオンサイトで対応する必要があれば、それについても記載しておきます。

  • 管理ログインのURL
  • ログインユーザIDとパスワード(管理者用/個人用/テスト用などの種別があれば)
  • AWSやGoogle Cloud Platform、Microsoft Azureなどのアカウント
  • その他、オンプレミスのサーバ情報等

どのように:作業や確認の具体的手順

手順書の本体ともいえます。具体的な作業については、初期のうちは自由に書いていって構いません。社内で横断的に、しかもある程度の長期間に渡って使われる資料です。他の担当者や上長、別の部署からの指摘やコメントが入ることで、自然と精度はどんどん高くなっていきます。また、作業だけでなく、それが確実に処理されたかを確認するステップも、必ずセットで明記しておきましょう。
途中で気づいた点やリスクをメモで残していくのも有効です。

誰に:連絡先

エスカレーション先として、連絡すべき担当者やチームの連絡先とチャンネルをセットで書いておきます。場合によっては、開発や保守チームに連絡する可能性も考慮します。

  • メールアドレス(メーリングリスト)
  • Slackなどのチャンネル
  • プロジェクト管理サービスのプロジェクト名/タスク名/担当者/投稿専用メールアドレスなど
  • SNSのメッセンジャー
  • SMS(ショートメッセージサービス)
  • (緊急連絡先の携帯電話番号)

システム運用手順書の整備が「運用」そのもの!

オンラインベースであれ、紙資料であれ、システム運用手順書も、一度作って完成ということはありません。システム技術のトレンドやデバイスの変遷、ネットワーク環境の変化、製品ラインナップの変更など、その時々でアップデートを繰り返し、よりわかりやすいものに更新し続けていく必要があります。これは、まさにシステム運用そのもの。
最初は、システムの詳細を把握している開発チームから出される簡単な資料をベースに、叩き台となる情報を整理するだけでも十分です。運用や保守チーム、ヘルプデスクなどとの間で、何度もフィードバックを繰り返しながら、それぞれの立場にとってより良い内容にブラッシュアップしていくことになります。

関連記事

ページ上部へ戻る