aj-geddes/useful-ai-prompts/deployment-documentation

Deployment Documentation

Table of Contents

• Overview
• When to Use
• Quick Start
• Reference Guides
• Best Practices

Overview

Create comprehensive deployment documentation covering infrastructure setup, CI/CD pipelines, deployment procedures, and rollback strategies.

When to Use

• Deployment guides
• Infrastructure documentation
• CI/CD pipeline setup
• Configuration management
• Container orchestration
• Cloud infrastructure docs
• Release procedures
• Rollback procedures

Quick Start

Minimal working example:

# 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:

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)