Webディレクターに捧ぐ……。保守案件でドキュメント化すべき3つの項目

Webディレクターのりくです！

ポケモンカードに相変わらずハマっています。ポケットモンスター金・銀ぶりにゲームも再開し、ヒスイ地方でポケモンを捕まえる日々を過ごしております。

さて、今回は保守案件のドキュメント化についてお話しします。保守案件を引き継ぐ機会が増えたのですが、この情報はどこに載っているんだろうと探すことが多く……。

引き継ぐときに後任担当者が欲しい情報をまとめましたので、最後までご覧いただけると幸いです。

保守案件引き継ぎ後に困ること

保守・運用案件引き継ぎ後も制作・開発時同様、多岐に渡る業務が存在します。そのため、運用担当者が変更時に引き継ぎが甘いと下記のような問題にぶつかります。

• サーバ情報がわからない
• サーバ情報が複数あって、対象サーバがどれかわからない
• サイト構成がわからない
• デザインデータの格納先がわからない
• WordPressのログイン情報がわからない
• 外部ベンダーの連絡先がわからない
• 辛い……助けて……

そう……わからないことが多いです……。だって初期制作時に担当してないんだから、当たり前！

引き継ぎが実施されても、実際に保守運用がはじまってから「あの情報どこにあるんだっけ？」「管理画面の使い方がわからない……」などスムーズに保守運用業務を進行できないことが往々にしてあります。

そして前任の担当者が社内にいるうちは直接確認ができますが、退職後だと確認する相手がいない、という非常に辛い状態になってしまうため引き継ぎ時にできるだけ完璧に情報をまとめる・聞き出す必要があります。

ということで保守案件の引き継ぎにおいて、絶対に確認しておきたい情報をまとめましたので、ご覧ください！

ドキュメント化するべき内容

1.企業情報

• クライアント名
• コーポレートサイトURL
• 業種・事業内容
• 事業年度

Webサイト改修の納品タイミングなどに影響するため、事前に把握しておきたい。

2.Webサイト概要

• 案件名（社内コミュニケーション時に使用する案件名）
• 運用・保守対象サイト名
• 運用・保守対象WebサイトURL（本番環境/テスト環境）
• 初期制作時のプロジェクト計画書

サイト構成などについて知りたいときは、初期制作時のプロジェクト計画書を見返すことで解決します。

• 初期制作時の提案資料

ご依頼背景や、サイト制作の目的などを把握するため。

• Bitbucket リポジトリ

Gitコード管理ツールです。改修発生時にエンジニアに共有する情報になります。

3.その他

• 体制図

社内体制

改修発生時の作業見積〜改修作業時に、可能であれば初期制作時に担当していたデザイナー/エンジニアにヒアリング・作業依頼をできたほうがスムーズに進行できるため、事前に把握しておきたい。

クライアント体制

提案〜改修時のスピード感や、LIG以外の制作会社との体制を把握するため。

• コミュニケーション方法
• 1Password Vault名

Webサービスのログインに必要なユーザーIDとパスワードを自動入力できるアプリです。クライアントのサーバ情報などはこちらに保管されているため、案件引き継ぎ時にVaultを共有してもらいます。

• Google Drive
• コミュニケーションツール

LIGの場合はコミュニケーションツールとして、スラックを利用することが多いです。

• Asana

LIGで使用しているタスク管理兼プロジェクト管理ツールです。

• 運用・保守契約内容

作業内容/稼働工数/契約更新タイミングなど

• サーバ/ドメイン/SSLの更新タイミング・更新フロー
• 請求書発行タイミング
• 工数超過時の対応について

工数超過が認められているのか？ 工数超過時のお客様へのご案内タイミングなど

• 過去に発生したトラブル内容

まとめ

保守運用案件担当者の方は、それぞれ引き継ぎ時に注目しているポイントや、独自の保守案件の情報整理などを行っていると思います。今回は私が引き継ぎ後に困った点や聞いておいたほうが良かった点、聞き逃して困った点などをまとめてみました。

でもこのボリュームのドキュメントを作成するのって、大変ですよね……。なので保守運用案件を担当しつつ、次期保守運用担当者のためにドキュメント整理を頑張っていきます……！！！

LIGはWebサイト制作を支援しています。ご興味のある方は事業ぺージをぜひご覧ください。