Web 開発向けのマニュアルテンプレ
そのまま貼り付けて、各項目( - xxx ) をページ ( /page )へ置換する
# 最初に読む
## 新規参画者向け
- 開発者用チュートリアル
- FAQ(詰まった時に読む)
- 用語集
## 全体把握
- キックオフ資料
- ユーザー向けパンフレット・操作資料
## 環境構築
- アカウント準備
- 環境構築
- ログイン情報
---
# 全体計画
## 長期
- ビジョン
- マイルストーン
## 中・短期
(長期マイルストーンを xxx へ落とし込みしている)
---
# 設計関連
## システム概要
- 全体構成図
- インフラ構成図
- 外部サービス
## 設計ドキュメント
- 基本設計
- 画面(ワイヤー)設計
- API設計
- DB設計
- 定期バッチ設計
- 環境変数・固定値管理
---
# DevOps
## 開発プロセス
- ブランチ運用
- レビュー方針
- テスト方針
- リリースフロー
- バージョン管理
## CI/CD
- デプロイ構成全体図
- パイプライン詳細構成
- CI
- CD
- アプリケーションデプロイ
- To Staging
- To Production 🔒
- インフラデプロイ
- To Staging
- To Production 🔒
---
# 保守運用
## Staging 環境
- アクセス方法
- 定期メンテナンス手順
- デプロイ手順
- ロールバック手順
## Production 環境 🔒
- アクセス方法
- 定期メンテナンス手順
- デプロイ手順
- ロールバック手順
## データ管理
- DB 直接参照
- To Staging
- To Production 🔒
- バックアップ・リストア
- To Staging
- To Production 🔒
## 監視・モニタリング
- アラート通知設定
- 月次レポート集計方法
---
# 作業記録
## 記録一覧
- 定型作業
- アップデートなど単発作業
- 本番リリースチェックリスト
- 引継記録
---
# その他
## 離任手続き
- 離任作業チェックリスト
## 管理者専用 🔒
- 秘匿情報管理
- システム本番アカウント(動作確認用)
- AWS root アカウント(社内ドライブへ退避済)
- VPN鍵
- DB踏み台鍵
- サーバー鍵