コンテンツにスキップ

05. 引き継ぎ索引

このページは、docs/05-delivery/handover/ 配下の引き継ぎ資料を目的別に案内する 索引です。受入先の開発担当・保守担当が、どこから読み始めれば保守開始準備に入れるかを 短時間で判断できるように整理しています。

この索引の使い方

目的別ショートカット

やりたいこと 最初に読む文書 補足
システムの全体構造を知りたい コードベース アーキテクチャ概要 実行構成・コード配置・外部依存の俯瞰
引き継ぎ開始後 30 分の読む順を知りたい 技術引き継ぎ書 権限移管、確認順、参照先の整理
どの資料を正本として見るか知りたい 技術引き継ぎ書 handover / maintenance / contract / implementation の役割分担
保守開始可否の最小チェックをしたい 技術引き継ぎ書 権限、健全性確認、runbook 導線、契約条件
コードのどの領域を見るべきか知りたい コードベース アーキテクチャ概要 Storefront / Vendure / plugins / shared packages の所在
障害時にどの runbook を開けばよいか知りたい 保守・障害対応索引 監視、緊急停止、バックアップ/復旧への導線

各文書の役割分担

文書 役割 正本として扱う内容
技術引き継ぎ書 引き継ぎ時の案内資料 何をどの順で確認し、どの資料を正本とするか
コードベース アーキテクチャ概要 俯瞰資料 構成、コード配置、環境境界、外部依存
保守・障害対応索引 保守 runbook の入口 日常運用、緊急停止、バックアップ/復旧の導線
保守・サポート計画書 契約条件の正本 SLA、窓口、対応範囲、料金体系
03. 実装仕様ポータル 実装詳細の入口 深掘り先の技術文書群

典型的な読み順

引き継ぎ開始 30 分

  1. コードベース アーキテクチャ概要
  2. 技術引き継ぎ書
  3. 03. 実装仕様ポータル
  4. 保守・障害対応索引
  5. 保守・サポート計画書

保守開始前の確認

  1. 権限移管と参照先を 技術引き継ぎ書 で確認する
  2. 構成の俯瞰を コードベース アーキテクチャ概要 で確認する
  3. 日常 runbook の入口を 保守・障害対応索引 で確認する
  4. 契約条件と窓口を 保守・サポート計画書 で確認する

関連ドキュメント