deployment-documentation
Document deployment processes, infrastructure setup, CI/CD pipelines, and configuration management. Use when creating deployment guides, infrastructure docs, or CI/CD documentation.
How do I install this agent skill?
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill deployment-documentationIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides templates and guides for deployment documentation, including CI/CD workflows and container configurations. Analysis found standard placeholders for credentials and references to trusted CI/CD tools and services.
- Socketwarn
2 alerts: gptAnomaly
- Snykpass
Risk: LOW · No issues
- Runlayerfail
4/7 files flagged
- ZeroLeakspass
Score: 93/100 · 2 sections analyzed
What does this agent skill do?
Deployment Documentation
Table of Contents
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:
| 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)
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/aj-geddes/useful-ai-prompts/deployment-documentation">View deployment-documentation on skillZs</a>