Skip to content

Infrastructure

Infrastructure documentation should be reproducible, precise and safe. Prefer tested commands, explicit prerequisites and verification steps over unexplained command dumps.

  • State prerequisites and required privileges.
  • Explain what a command changes.
  • Include a read-only verification step.
  • Keep secrets out of examples and Git repositories.
  • Describe recovery or rollback for impactful changes.