Deployment Guide

What it does

This skill generates tailored deployment guides for applications, focusing on creating production-ready documentation. It structures these guides with prerequisites, environment-specific instructions, verification steps after each phase, rollback procedures, and operational readiness considerations. The generated documents include detailed commands with expected outputs, version specifications for tools used, and explanations of why each step is necessary.

When to use it

• Creating deployment documentation for new applications being released into production.
• Generating updated deployment guides when application architecture or target environments change.
• Standardizing the deployment process across different teams or projects.
• Documenting rollback procedures for rapid recovery in case of deployment failures.
• Preparing for maintenance windows and ensuring operational readiness.

Key capabilities

• Generates structured deployment guides including overview, prerequisites, pre-deployment checklist, and phased deployment instructions.
• Specifies system requirements (OS, RAM, Disk, Network).
• Lists required tools with version specifications (Docker, kubectl, Helm).
• Details access and security requirements for the deployment process.
• Includes estimated execution times for each phase.
• Provides imperative commands with expected outputs for each step.

Example prompts

• "Generate a deployment guide for 'myapp' using blue-green deployment strategy."
• "Create a deployment guide outlining steps for Kubernetes on Ubuntu 22.04 LTS, requiring Docker version 24.0+."
• “Give me a deployment guide with rollback procedures and a pre-deployment checklist.”

Tips & gotchas

• The skill requires information about the application architecture, target environment specifications, and desired deployment strategy to generate accurate guides.
• Pay close attention to version specifications for tools listed in the generated documentation as they are critical for successful deployments.
• Estimated execution times are provided as a guideline and may vary depending on data size or other factors.