mcpField
D
deployment-documentation

deployment-documentation

github.com/aj-geddesクラウド・DevOps373453 回インストール34 週間前に更新
リポジトリ

deployment-documentation について

deployment-documentation は、インフラ、リリース、運用手順を文書化するチーム向けのスキルです。CI/CD、デプロイ手順、構成管理、ロールバックを扱い、一般的なデプロイファイルのガイドも含みます。

主な機能

  1. 01インフラ構成の文書化
  2. 02CI/CD パイプラインとリリース手順の記録
  3. 03コンテナオーケストレーションとデプロイマニフェストの説明
  4. 04ロールバックと緊急手順の計画
  5. 05GitHub Actions、Dockerfile、docker-compose.yml のガイド

活用シーン

  1. 01アプリケーションのデプロイガイド作成
  2. 02クラウドインフラと構成管理の記録
  3. 03リリースおよびロールバック手順の計画
  4. 04デプロイ監視と緊急時文書の整備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill deployment-documentation

インストール後、Claude Code で/deployment-documentationを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
deployment-manifest.md
docker-composeyml.md
dockerfile.md
github-actions-workflow.md
scripts/
validate-config.sh
templates/
config-starter.yaml

詳細

デプロイメントドキュメント

目次

概要

インフラストラクチャのセットアップ、CI/CD パイプライン、デプロイ手順、ロールバック戦略を網羅したデプロイメントドキュメントを作成します。

使用する場面

  • デプロイガイド
  • インフラストラクチャのドキュメント
  • CI/CD パイプラインのセットアップ
  • 構成管理
  • コンテナオーケストレーション
  • クラウドインフラストラクチャのドキュメント
  • リリース手順
  • ロールバック手順

クイックスタート

最小限の動作例：

# Deployment Guide

## Overview

This document describes the deployment process for [Application Name].

**Deployment Methods:**

- Manual deployment (emergency only)
- Automated CI/CD (preferred)
- Blue-green deployment
- Canary deployment

**Environments:**

- Development: https://dev.example.com
- Staging: https://staging.example.com
- Production: https://example.com

---

## Prerequisites

### Required Tools

// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [GitHub Actions Workflow](references/github-actions-workflow.md) | GitHub Actions Workflow |
| [Dockerfile](references/dockerfile.md) | Dockerfile |
| [docker-compose.yml](references/docker-composeyml.md) | docker-compose.yml |
| [Deployment Manifest](references/deployment-manifest.md) | Deployment Manifest |

## Best Practices

### ✅ DO

- Use infrastructure as code
- Implement CI/CD pipelines
- Use container orchestration
- Implement health checks
- Use rolling deployments
- Have rollback procedures
- Monitor deployments
- Document emergency procedures
- Use secrets management
- Implement blue-green or canary deployments

### ❌ DON'T

- Deploy directly to production
- Skip testing before deploy
- Forget to backup before migrations
- Deploy without rollback plan
- Skip monitoring after deployment
- Hardcode credentials
- Deploy during peak hours (unless necessary)

コメント

Markdown 対応