/arn-infra-document-change
This skill should be used when the user says "document infra change", "infrastructure documentation", "generate runbook", "infra docs", "arn infra document", "create infra changelog", "document infrastructure", "generate infrastructure docs", "infra documentation", "create
$ npx -y skills add AppsVortex/arness --skill arn-infra-document-change --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
- Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.
- You can call itInvoke it directly when you want it.
- Slash command
/arn-infra-document-change
Context preview
The summary Claude sees to decide when to auto-load this skill.
This skill should be used when the user says "document infra change", "infrastructure documentation", "generate runbook", "infra docs", "arn infra document", "create infra changelog", "document infrastructure", "generate infrastructure docs", "infra documentation", "create
SKILL.md
arn-infra-document-change.SKILL.mdname: arn-infra-document-change
description: >-
This skill should be used when the user says "document infra change",
"infrastructure documentation", "generate runbook", "infra docs",
"arn infra document", "create infra changelog", "document infrastructure",
"generate infrastructure docs", "infra documentation", "create runbook",
"generate changelog", "arn-infra-document-change", or wants to generate
operational documentation (runbooks, architecture updates, changelogs,
environment docs) from completed infrastructure changes.
version: 1.0.0
Arness Infra Document Change
Generate comprehensive operational documentation from completed infrastructure changes. This skill reads the change spec, plan, execution reports, and review report, then produces runbooks, architecture updates, operational playbooks, environment documentation, and changelog entries -- all written to the configured Infra docs directory.
This is the final step in the infrastructure change pipeline: change-spec -> change-plan -> save-plan -> execute-change -> review-change -> **document-change**.
Prerequisites
Read `## Arness` from the project's CLAUDE.md. If no `## Arness` section exists or Arness Infra fields are missing, inform the user: "Arness Infra is not configured for this project yet. Run `/arn-infra-wizard` to get started — it will set everything up automatically." Do not proceed without it.
Check the **Deferred** field. If `Deferred: yes`, inform the user: "Infrastructure is in deferred mode. Documentation generation is not available until infrastructure is fully configured. Run `/arn-infra-assess` to un-defer." Stop.
Extract:
- **Infra docs directory** -- where documentation artifacts are written (default: `.arness/infra-docs`)
- **Infra plans directory** -- where structured plan projects live (default: `.arness/infra-plans`)
- **Infra specs directory** -- where change specs are stored (default: `.arness/infra-specs`)
- **Providers** -- cloud providers configured
- **Environments** -- environment names
- **Experience level** -- derived from user profile. Read `~/.arness/user-profile.yaml` (or `.claude/arness-profile.local.md` if it exists — project override takes precedence). Apply the experience derivation mapping from `${CLAUDE_PLUGIN_ROOT}/skills/arn-infra-ensure-config/references/experience-derivation.md`. If no profile exists, check for legacy `Experience level` in `## Arness` as fallback.
Resolve **Infra docs directory** (default: `.arness/infra-docs`). If the directory does not exist on disk, offer to create it: "The infra docs directory `<path>` does not exist yet. I can create it now. Proceed?"
Locate the Completed Change Project
Search for completed change projects:
Glob <infra-plans-dir>/*/PROGRESS_TRACKER.json
Filter to projects where `overallStatus === "completed"` or where at least one phase has `execution.status === "completed"`.
**If one eligible project found:** Auto-select it. **If multiple eligible projects found:** Present the list. Ask the user to select. **If no eligible project found:** Inform the user: "No completed change projects found. Run `/arn-infra-execute-change` to execute a change plan first."
---
Workflow
Step 1: Gather Documentation Inputs
Read all artifacts from the selected project:
1. **Change spec:** The original `INFRA_CHANGE_*.md` specification 2. **Source plan:** `SOURCE_PLAN.md` from the project directory 3. **INTRODUCTION.md:** Project overview with cost budget, security requirements, rollback strategy 4. **Phase reports:** All `INFRA_CHANGE_REPORT_PHASE_N.json` files 5. **Review report:** `INFRA_REVIEW_REPORT.json` (if available -- review is recommended but not required) 6. **PROGRESS_TRACKER.json:** Overall execution status
Present a documentation scope summary: "**Documentation scope:**
- **Project:** [name]
- **Phases documented:** [N]
- **Environments:** [list]
- **Resources:** [count]
- **Review verdict:** [pass/warn/needs-fixes or 'not reviewed']
I will generate the following documentation:
- Runbook (deployment and rollback procedures)
- Architecture update (resource inventory and diagram)
- Operational playbook (day-2 operations)
- Environment documentation (per-environment details)
- Changelog entry (structured change record)"
Ask (using `AskUserQuestion`):
**"Proceed with generating documentation?"**
Options: 1. **Yes** -- Generate all documentation artifacts 2. **No** -- Cancel documentation generation
---
Experience-Level Adaptation
Before generating documentation artifacts in Steps 2-6, note the user's experience level (derived from user profile) and apply these principles:
- **Expert:** Concise documentation, command-focused, minimal prose. Assume familiarity with tools and cloud concepts. Focus on reference material: command tables, endpoint lists, configuration values.
- **Intermediate:** Balanced documentation with context and commands. Include brief explanations of trade-offs and alternatives. Highlight areas that may need customization.
- **Beginner:** Detailed documentation with explanations and examples. Include plain-language descriptions of what each resource does and why. Add common pitfalls and how to avoid them. Include screenshots or dashboard navigation instructions where relevant.
---
Step 2: Generate Runbook
> Read `${CLAUDE_PLUGIN_ROOT}/skills/arn-infra-document-change/references/runbook-template.md` for the runbook template.
Generate a runbook following the template structure with infrastructure-specific content from the phase reports and plan.
Populate all 8 sections: 1. **Change Summary** -- from spec and INTRODUCTION.md 2. **Prerequisites** -- tools from tooling manifest, credentials from provider config 3. **Deployment Steps** -- from phase reports (exact commands used, in order) 4. **Verification Steps** -- from verification data in phase reports 5. **Rollback Procedure** -- from INTRODUCTION.md rollback strategy and phase checkpoints 6. **Monitori
Read more
name: arn-infra-document-change description: >- This skill should be used when the user says "document infra change", "infrastructure documentation", "generate runbook", "infra docs", "arn infra document", "create infra changelog", "document infrastructure", "generate infrastructure docs", "infra documentation", "create runbook", "generate changelog", "arn-infra-document-change", or wants to generate operational documentation (runbooks, architecture updates, changelogs, environment docs) from completed infrastructure changes. version: 1.0.0
Arness Infra Document Change
Generate comprehensive operational documentation from completed infrastructure changes. This skill reads the change spec, plan, execution reports, and review report, then produces runbooks, architecture updates, operational playbooks, environment documentation, and changelog entries -- all written to the configured Infra docs directory.
This is the final step in the infrastructure change pipeline: change-spec -> change-plan -> save-plan -> execute-change -> review-change -> **document-change**.
Prerequisites
Read `## Arness` from the project's CLAUDE.md. If no `## Arness` section exists or Arness Infra fields are missing, inform the user: "Arness Infra is not configured for this project yet. Run `/arn-infra-wizard` to get started — it will set everything up automatically." Do not proceed without it.
Check the **Deferred** field. If `Deferred: yes`, inform the user: "Infrastructure is in deferred mode. Documentation generation is not available until infrastructure is fully configured. Run `/arn-infra-assess` to un-defer." Stop.
Extract:
- **Infra docs directory** -- where documentation artifacts are written (default: `.arness/infra-docs`)
- **Infra plans directory** -- where structured plan projects live (default: `.arness/infra-plans`)
- **Infra specs directory** -- where change specs are stored (default: `.arness/infra-specs`)
- **Providers** -- cloud providers configured
- **Environments** -- environment names
- **Experience level** -- derived from user profile. Read `~/.arness/user-profile.yaml` (or `.claude/arness-profile.local.md` if it exists — project override takes precedence). Apply the experience derivation mapping from `${CLAUDE_PLUGIN_ROOT}/skills/arn-infra-ensure-config/references/experience-derivation.md`. If no profile exists, check for legacy `Experience level` in `## Arness` as fallback.
Resolve **Infra docs directory** (default: `.arness/infra-docs`). If the directory does not exist on disk, offer to create it: "The infra docs directory `<path>` does not exist yet. I can create it now. Proceed?"
Locate the Completed Change Project
Search for completed change projects:
Glob <infra-plans-dir>/*/PROGRESS_TRACKER.json
Filter to projects where `overallStatus === "completed"` or where at least one phase has `execution.status === "completed"`.
**If one eligible project found:** Auto-select it. **If multiple eligible projects found:** Present the list. Ask the user to select. **If no eligible project found:** Inform the user: "No completed change projects found. Run `/arn-infra-execute-change` to execute a change plan first."
---
Workflow
Step 1: Gather Documentation Inputs
Read all artifacts from the selected project:
1. **Change spec:** The original `INFRA_CHANGE_*.md` specification 2. **Source plan:** `SOURCE_PLAN.md` from the project directory 3. **INTRODUCTION.md:** Project overview with cost budget, security requirements, rollback strategy 4. **Phase reports:** All `INFRA_CHANGE_REPORT_PHASE_N.json` files 5. **Review report:** `INFRA_REVIEW_REPORT.json` (if available -- review is recommended but not required) 6. **PROGRESS_TRACKER.json:** Overall execution status
Present a documentation scope summary: "**Documentation scope:**
- **Project:** [name]
- **Phases documented:** [N]
- **Environments:** [list]
- **Resources:** [count]
- **Review verdict:** [pass/warn/needs-fixes or 'not reviewed']
I will generate the following documentation:
- Runbook (deployment and rollback procedures)
- Architecture update (resource inventory and diagram)
- Operational playbook (day-2 operations)
- Environment documentation (per-environment details)
- Changelog entry (structured change record)"
Ask (using `AskUserQuestion`):
**"Proceed with generating documentation?"**
Options: 1. **Yes** -- Generate all documentation artifacts 2. **No** -- Cancel documentation generation
---
Experience-Level Adaptation
Before generating documentation artifacts in Steps 2-6, note the user's experience level (derived from user profile) and apply these principles:
- **Expert:** Concise documentation, command-focused, minimal prose. Assume familiarity with tools and cloud concepts. Focus on reference material: command tables, endpoint lists, configuration values.
- **Intermediate:** Balanced documentation with context and commands. Include brief explanations of trade-offs and alternatives. Highlight areas that may need customization.
- **Beginner:** Detailed documentation with explanations and examples. Include plain-language descriptions of what each resource does and why. Add common pitfalls and how to avoid them. Include screenshots or dashboard navigation instructions where relevant.
---
Step 2: Generate Runbook
> Read `${CLAUDE_PLUGIN_ROOT}/skills/arn-infra-document-change/references/runbook-template.md` for the runbook template.
Generate a runbook following the template structure with infrastructure-specific content from the phase reports and plan.
Populate all 8 sections: 1. **Change Summary** -- from spec and INTRODUCTION.md 2. **Prerequisites** -- tools from tooling manifest, credentials from provider config 3. **Deployment Steps** -- from phase reports (exact commands used, in order) 4. **Verification Steps** -- from verification data in phase reports 5. **Rollback Procedure** -- from INTRODUCTION.md rollback strategy and phase checkpoints 6. **Monitori
Showing the first part of this file.
Arness — H not required. Structured AI workflows for Claude Code. From first idea to production deploy. Seven entry commands. That's all you need to remember.
Repo: AppsVortex/arness
Other skills on arness.
- /arn-assessing
This skill should be used when the user says "assessing", "arness assessing", "assess", "assess codebase", "technical review", "codebase assessment", "find improvements", "what should I improve", "tech debt review", "pattern compliance check", "codebase health check",
Open skill - /arn-code-assess
This skill should be used when the user says "arness code assess", "arn-code-assess", "assess codebase", "technical review", "codebase assessment", "find improvements", "what should I improve", "tech debt review", "tech debt audit", "pattern compliance check", "codebase health
Open skill - /arn-code-batch-cve-fix
This skill should be used when the user says "fix CVEs", "patch vulnerabilities", "apply security patches", "resolve security advisories", "batch CVE fix", "patch dependencies", "fix security findings", "remediate CVEs", "apply CVE fixes", "batch fix vulnerabilities", "resolve
Open skill - /arn-code-batch-cve-scan
This skill should be used when the user says "scan for CVEs", "CVE scan", "check for vulnerabilities", "find vulnerabilities", "check security advisories", "dependabot triage", "dependabot scan", "scan dependencies for security issues", "audit dependencies", "vulnerability
Open skill - /arn-code-batch-implement
This skill should be used when the user says "batch implement", "implement all", "batch execution", "implement all features", "parallel implement", "implement in parallel", "arness batch implement", "arn-code-batch-implement", "run batch implementation", "implement everything",
Open skill - /arn-code-batch-merge
This skill should be used when the user says "batch merge", "merge batch", "arness batch merge", "arn-code-batch-merge", "merge all PRs", "merge batch PRs", "merge the batch", "merge implemented features", "batch merge PRs", "merge open PRs", "merge all feature PRs", "combine
Open skill

