Skills Guide

Create Deployment Documentation

VerifiedCaution

Create a deployment guide for a service or application, following the PDLC process with code review verification.

Download and use
Sby Skills Guide Bot
DevOpsIntermediate
7/23/2026
Claude Code
#deployment#documentation#runbook#rollback#pdlc

Recommended for

Backend developerClaude CodeAuto documentationDevOps engineerGit automation

Automated summary

Generates a structured deployment guide for a given service, after confirming that a code review exists in the PDLC workflow.

Strengths

  • Hard pre-check gate: stops and refuses to write documentation when no matching code review is found
  • Produces a traceable document with a PDLC-TRACE header (feature ID, upstream review path) and a normalized filename
  • Runs a self-review pass that auto-fixes missing sections such as health checks, rollback, environment variables and troubleshooting
  • Clearly separates writing deployment documentation from actually executing a deployment

Limitations

  • Does not perform any real deployment; output is documentation only
  • Heavily depends on the presence of review records and internal templates/ includes to run correctly
  • Document quality depends on the README and architecture docs it reads, which may be missing or outdated
When to use it

Use it once a service has passed code review and you need a deployment runbook with rollback steps and health verifications.

When not to use it

Don't use it to trigger or automate an actual production deployment, or when the feature has no code review record yet.

Security analysis

Caution
Quality score85/100

The skill is primarily a documentation generator and explicitly warns that real deployment is destructive and requires human confirmation. However, it grants Bash and permits automated scanning/editing during self-review, so it uses powerful tools for legitimate purposes but has some execution risk if misapplied.

Findings
  • •Allows Bash, which could be used to execute arbitrary shell commands during documentation generation or self-review.
  • •Automatic fixes may scan code and modify generated deployment docs, creating side effects if instructions are misapplied.
  • •References external template/include files that are not embedded, so behavior depends on repository contents.
How this analysis is made

Examples

Générer un manuel de déploiement
/pdlc-deploy user-auth
Déploiement avec Docker
/pdlc-deploy payment-service — 需要 Docker 部署，请同时生成 Dockerfile 和 docker-compose.yml
Après une revue de code
/pdlc-deploy order-api  请基于 docs/07_reviews/code 下最新的评审记录生成部署手册，并包含回滚方案

name: pdlc-deploy description: 创建部署文档 argument-hint: <服务名 | 应用名> allowed-tools: Read, Write, Edit, Glob, Grep, Bash layer: 2 stage: deploy produces:

  • docs/05_deployment/** requires: [] next_step: null terminal_state: deploy_done

创建部署文档

<!-- @include templates/prompts/iron-law.md --> <!-- @include templates/prompts/noninteractive.md -->

⛔ 部署面向生产、不可逆·外发：真实执行部署属破坏性范畴。--autonomous 对涉及真实部署动作的环节无效——仍必须人工显式确认。本命令默认只产出部署文档，不代表授权自动上线。

为指定服务或应用创建部署手册。

PDLC 前置检查（必须执行，不可跳过）

  1. 从用户输入中提取服务/功能名称关键词
  2. 在 docs/07_reviews/code/ 目录下搜索包含该关键词的评审记录
    • 匹配新格式：F<日期>-<编号>-*<关键词>*-review.md
    • 匹配旧格式：YYYYMMDD-*<关键词>*-review.md
    • 同时检查文件内容中是否包含该关键词
  3. 未找到评审记录 → 输出以下信息后立即停止，不继续执行： 
    ⛔ PDLC 守卫：未找到与「<功能名>」相关的评审记录。
部署文档必须基于已完成评审的代码。请先运行：
👉 /pdlc-review <评审目标>
  4. 找到 → 提取功能ID（如 F20260326-090000），读取评审记录内容，继续执行

工作流程

  1. 阅读目标服务/应用的 README.md 和技术栈信息
  2. 阅读 docs/02_design/architecture/ 下的架构设计文档（如有）
  3. 阅读评审记录，确认功能状态
  4. 【必须创建文件】 在 docs/05_deployment/guides/ 下创建部署手册
    • 使用模板: templates/deploy-doc-template.md（结构完整、章节齐全）
    • 文件名格式: <功能ID>-<功能名>-deploy.md（如 F20260326-090000-user-auth-deploy.md）
      • 若无功能ID，则使用旧格式 YYYYMMDD-<服务名>-deploy.md
    • 文档顶部必须包含 PDLC 追溯头： 
      <!-- PDLC-TRACE -->
<!-- 功能ID: F20260326-090000 -->
<!-- 功能名称: user-auth -->
<!-- 阶段: 部署 -->
<!-- 前置文档: docs/07_reviews/code/F20260326-090000-user-auth-review.md -->

文档内容

  • 前置条件（环境要求、依赖服务）
  • 环境配置（环境变量、配置文件）
  • 构建步骤
  • 部署步骤
  • 健康检查验证
  • 回滚方案
  • 常见问题排查

部署文档自审与自动修复（创建后立即执行，不可跳过）

重新阅读刚创建的部署文档，逐项检查以下质量门禁：

关键章节检查

  • [ ] 前置条件：是否列出了所有运行时依赖（数据库版本、中间件版本、系统配置）
  • [ ] 环境变量：是否列出了每个环境变量的名称、用途、示例值、是否必填
  • [ ] 构建步骤：是否可直接复制执行，无需额外推断
  • [ ] 部署步骤：是否区分了首次部署与升级部署
  • [ ] 健康检查：是否定义了健康检查 URL、预期响应、超时时间
  • [ ] 回滚方案：是否有明确的回滚步骤（不是简单写「回滚到上一版本」）
  • [ ] 数据库迁移：如涉及 DB 变更，是否有迁移执行和回滚步骤
  • [ ] 常见问题排查：是否有至少 3 个常见错误场景及解决方案

可执行性检查

  • [ ] 所有命令是否完整可复制（无省略号 ...、无占位符未说明）
  • [ ] 端口号、域名、路径是否使用了变量或占位符并在前置条件中说明
  • [ ] 步骤顺序是否合理（不会因顺序错误导致部署失败）

自动修复

  • 缺失的健康检查：根据服务类型（HTTP/gRPC）自动补充标准健康检查配置
  • 缺失的回滚方案：自动补充基于版本的回滚步骤模板
  • 缺失的环境变量说明：从代码中扫描 process.env/os.Getenv/System.getenv 等，自动补充
  • 模糊的操作步骤：改写为具体命令
  • 缺失的常见问题：自动补充 3 个通用排查项（端口占用、权限不足、依赖不可达）
  • 修复后在文档末尾追加审查记录： 
    ## 自审记录
- 审查时间：<ISO 8601>
- 发现问题：X 项
- 自动修复：X 项
- 修复明细：
  - [已修复] <问题描述>

要求

<!-- @include templates/prompts/output-language.md -->
  • 步骤要具体可执行，不要模糊描述
  • 包含回滚方案
  • 如需 Docker 部署，同时生成 Dockerfile 和 docker-compose.yml

目标: $ARGUMENTS

<!-- @include templates/prompts/state-update.md --> <!-- @include templates/prompts/handoff.md -->

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/create-deployment-documentation-mrx3xxip' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/create-deployment-documentation-mrx3xxip/download' --output '.skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md.part' && mv '.skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md.part' '.skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Read, Write, Edit, Glob, Grep, Bash

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md' && test -s '.skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/pdlc-deploy' && cp -R '.skill-downloads/create-deployment-documentation-mrx3xxip' '.claude/skills/pdlc-deploy'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/create-deployment-documentation-mrx3xxip'

openskills read 'create-deployment-documentation-mrx3xxip'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Configure a Chat Channel with SecretRefs

DevOps

Set up chat channels using non-interactive commands, with secrets only as SecretRefs. Covers gather, mutate, repair, and prove steps for reliable delivery.

Claude CodeCodexintermediateSafe 387,940
Skills Guide Bot

Investigate ClickHouse CI Failures

DevOps

Investigate a ClickHouse CI failure end-to-end from a PR or S3 report URL. Fetches failed tests, classifies flaky vs real regression, and checks for existing issues/fixes.

Claude CodeadvancedSafe 49,516
Skills Guide Bot

Ansible PR Review

DevOps

Reviews an Ansible PR following the project's standardized process, including changelog checks, test coverage validation, and feedback tracking.

Claude CodeintermediateSafe 70,491
Skills Guide Bot