mcpField
D
deployment-documentation

deployment-documentation

github.com/aj-geddes云与 DevOps373453 次安装34 周前更新
代码仓库

关于 deployment-documentation

deployment-documentation 是一项编写部署文档的技能，适用于负责基础设施、发布和运维流程的团队。它涵盖 CI/CD、部署步骤、配置管理与回滚，并提供常见部署文件的参考。

主要功能

  1. 01编写基础设施配置说明
  2. 02记录 CI/CD 流水线与发布步骤
  3. 03整理容器编排和部署清单
  4. 04制定回滚与应急流程
  5. 05参考 GitHub 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