Use when producing or updating infrastructure documentation for topology, environments, dependencies, configuration ownership, recovery, and change controls. Use deployment-guide for the neighbouring concern; this skill owns the named document contract and its acceptance evidence.
Instrucciones de origen · Vista previa de solo lectura
name
04-infrastructure-docs
description
Use when producing or updating infrastructure documentation for topology, environments, dependencies, configuration ownership, recovery, and change controls. Use deployment-guide for the neighbouring concern; this skill owns the named document contract and its acceptance evidence.
Failures and unavailable checks cannot appear as passes.
Review record
Reviewer, date, disposition, open actions
The consumer can reproduce the acceptance decision.
Capability and Permission Boundaries
Minimum capabilities: read and search the authorised project sources. Execution is optional and limited to non-destructive validation.
Assessment and planning default to read-only. Create or edit the named project document only when the request explicitly authorises it. Production mutation, publishing, destructive action, spending, external communication, or certification claims require separate explicit authority.
Treat secrets, tenant data, incident evidence, and financial records as least-privilege inputs; expose only the minimum evidence needed for review.
Degraded Mode
If files, execution, network, rendering, environment access, fonts, or current evidence are unavailable, return the narrowest useful draft plus a gap register. Label affected checks not assessed, retain the intended acceptance oracle, and state who must supply or verify the missing evidence. Never convert an unavailable check into a pass.
Decision Rules
Choice
Action
Failure or risk avoided
Evidence is complete and authority is explicit
Choose documentation depth from operational and audit risk and produce the full artefact.
A diagram that omits dependencies or recovery.
A required source or approval is missing
Stop the affected branch; record the gap, owner, and unblock condition.
Fabricated requirements or unauthorised action.
Evidence conflicts across sources
Preserve both claims, identify the controlling owner, and request a recorded decision.
Silent selection of a convenient but wrong source.
A check cannot run in the available environment
Keep its oracle and mark it not assessed; require later execution evidence.
False assurance from capability limits.
Workflow
Confirm the named deliverable, consumer, scope, environment, authority, and neighbouring-skill boundary.
Inventory required sources and validate provenance, freshness, internal consistency, and missing inputs. Stop the affected branch on a mandatory gap.
Extract traceable requirements, invariants, risks, and measurable acceptance criteria; record conflicts before choosing a design or procedure.
Apply the decision rules and the domain workflow below. For a failed branch, preserve evidence, choose the documented recovery path, or escalate to the named owner.
Draft the artefact, decision register, and evidence record together. Do not defer failure handling, rollback, security, tenancy, accessibility, or operational ownership.
Run available checks, review every result, repair failures, and hand off only when acceptance is observable. If recovery fails or authority is exceeded, stop and escalate without mutation.
Quality Standards
Ground every section in a named project source, decision, measured result, or accountable owner.
Give each requirement or procedure a deterministic oracle that another reviewer can reproduce.
Keep assumptions, exclusions, degraded checks, residual risks, and waivers visible at handoff.
Preserve the domain invariants and more specific controls in the existing workflow below; this contract does not replace them.
Run the repository anti-AI-slop gate: remove filler, verify named standards and dependencies, and retain purposeful domain detail.
Anti-Patterns
Copying a generic template without mapping it to project sources. Fix: attach each section to an approved requirement, configuration, risk, or owner.
Choosing a threshold because it is common practice. Fix: derive it from a requirement, measured baseline, risk decision, or current verified source.
Reporting an inaccessible or unexecuted check as passed. Fix: mark it not assessed, preserve the oracle, and name the verifier.
Mixing the neighbouring deployment-guide concern into this artefact without a boundary. Fix: cross-reference its output and keep ownership explicit.
Omitting failure, rollback, empty-state, security, tenancy, or escalation behaviour. Fix: specify the trigger, safe action, verification, and owner for each applicable case.
Mutating a repository, environment, tenant, ledger, or external system while drafting guidance. Fix: remain read-only until the exact mutation and authority are explicit.
Claiming compliance, certification, readiness, or release from prose alone. Fix: require source-attributed evidence and a named acceptance decision.
Worked Example
Given an approved project source and a conflicting implementation detail, record both with provenance, stop the affected branch, and obtain the accountable owner's decision. Then update the relevant contract, define a reproducible acceptance check, and retain its observed result. The artefact is accepted only when the documented topology matches deployed evidence and names ownership, recovery assumptions, and sensitive configuration boundaries.
References
logic.prompt - load only when its template, logic, or detail is needed.
README.md - load only when its template, logic, or detail is needed.
Overview
This is the fourth skill in Phase 06 (Deployment & Operations). It produces infrastructure documentation that defines architecture diagrams (Mermaid), compute resource specifications per environment, network topology, storage architecture, Infrastructure-as-Code references, and backup/disaster recovery procedures. The output conforms to IEEE 1016-2009 and provides a complete infrastructure reference for DevOps and platform engineering teams.
When to Use
After 02-runbook and 03-monitoring-setup complete (they provide operational and observability context).
When HLD.md exists in projects/<ProjectName>/<phase>/<document>/ with system architecture and component topology.
When tech_stack.md is present in projects/<ProjectName>/_context/ with technology choices and infrastructure tooling.
Complete infrastructure documentation with diagrams, resources, network, storage, IaC, and DR
Core Instructions
Follow these seven steps in order. Halt and notify the user if a required input file is missing.
Step 1: Read Context Files
Read HLD.md from projects/<ProjectName>/<phase>/<document>/ and tech_stack.md from projects/<ProjectName>/_context/. Log the absolute path of each file read. Halt if any required file is missing.
CI/CD pipeline configuration file locations
Document backup and disaster recovery:
Backup schedule, retention policy, and storage location
Recovery Point Objective (RPO) and Recovery Time Objective (RTO)
Disaster recovery procedure (failover steps, data restoration)
DR testing schedule
Step 7: Write Output with Cost Estimates
Produce a cost estimate summary table per environment. Write the completed document to projects/<ProjectName>/<phase>/<document>/Infrastructure_Docs.md. Log the total count of compute resources, network components, and storage systems documented.
