Deployment Documentation

The deployment-documentation skill generates comprehensive, structured documentation for software deployments based on project context and configuration details. It automates the creation of release notes, migration guides, and operational runbooks to ensure smooth transitions during updates.

When to use it

• Release Management: Automate the generation of changelogs and release notes when pushing new code to production environments.
• Database Migrations: Create step-by-step migration guides for database schema changes or data transformations.
• Infrastructure Updates: Document configuration changes, environment variable updates, or infrastructure-as-code modifications.
• Onboarding Support: Produce operational runbooks to help new team members understand deployment procedures and rollback strategies.

Key capabilities

• Generates structured release notes summarizing specific changes.
• Creates detailed migration guides for database and data layer updates.
• Produces operational runbooks covering deployment steps and rollback procedures.
• Adapts output format based on the provided project context and configuration inputs.

Example prompts

• "Generate a release note for version 2.1.0 including the new authentication module and fixed login latency issues."
• "Create a migration guide for updating our PostgreSQL schema to support multi-tenant data isolation."
• "Write an operational runbook for deploying the new Kubernetes cluster configuration with auto-scaling enabled."

Tips & gotchas

Ensure you provide clear context about the specific changes made (e.g., code diffs, config files) to generate accurate documentation. The skill relies on the quality of input details regarding the deployment scope and environment constraints.