Skills Guide

Création de documentation de déploiement

VérifiéPrudence

Crée un manuel de déploiement pour un service ou une application, en suivant le processus PDLC avec vérification des revues de code.

Télécharger et utiliser
Spar Skills Guide Bot
DevOpsIntermédiaire
23/07/2026
Claude Code
#deployment#documentation#runbook#rollback#pdlc

Recommandé pour

Développeur backendClaude CodeDocumentation automatiqueIngénieur DevOpsAutomatisation Git

Synthèse automatique

Génère un manuel de déploiement structuré pour un service donné, après avoir vérifié qu'une revue de code existe dans le cycle PDLC.

Points forts

  • Contrôle préalable bloquant : refuse de produire la documentation si aucune revue de code correspondante n'est trouvée
  • Produit un document tracé (en-tête PDLC-TRACE avec ID de fonctionnalité et documents préalables) et un nom de fichier normalisé
  • Auto-révision systématique avec correction automatique des sections manquantes (santé, rollback, variables d'environnement, dépannage)
  • Sépare explicitement la rédaction de la documentation de toute exécution réelle de déploiement

Limites

  • N'effectue aucun déploiement réel : il ne produit que de la documentation
  • Dépend fortement de la présence des fichiers de revue et des modèles internes (templates/) pour fonctionner
  • Le contenu de qualité repose sur la lecture du README et des documents d'architecture, qui peuvent être absents ou obsolètes
Quand l'utiliser

À utiliser lorsqu'un service a terminé sa revue de code et que vous voulez produire rapidement un manuel de déploiement avec rollback et vérifications de santé.

Quand l'éviter

Ne l'utilisez pas pour lancer ou automatiser un déploiement réel en production, ni si aucune revue de code n'existe encore pour la fonctionnalité.

Analyse de sécurité

Prudence
Score qualité85/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.

Points d'attention
  • •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.
Comment cette analyse est faite

Exemples

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 -->

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

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. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Glob, Grep, Bash

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

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 doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/create-deployment-documentation-mrx3xxip'

openskills read 'create-deployment-documentation-mrx3xxip'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/create-deployment-documentation-mrx3xxip/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Configurer un canal de discussion avec SecretRefs

DevOps

Configurez des canaux de discussion avec des commandes non interactives, les secrets étant uniquement des SecretRefs. Couvre les étapes de collecte, modification, réparation et vérification.

Claude CodeCodexintermediateSûr 387,940
Skills Guide Bot

Enquêter sur les échecs CI de ClickHouse

DevOps

Investigue un échec CI de ClickHouse de bout en bout à partir d'une URL de PR ou de rapport S3. Récupère les tests échoués, classe flaky vs vraie régression, et cherche des issues/fixes existants.

Claude CodeadvancedSûr 49,516
Skills Guide Bot

Revue de PR Ansible

DevOps

Examine une PR Ansible selon le processus standardisé du projet, incluant la validation des changelogs, la couverture de tests et le suivi des commentaires.

Claude CodeintermediateSûr 70,491
Skills Guide Bot