Skip to content

Documentation

Maintainer Manual

The Maintainer Manual is Akurium’s project memory. It records the commands, procedures, architecture, and non-obvious decisions that are easy to forget after six quiet months.

Pages should optimize for completing a real task. A useful runbook explains:

  1. When and why to use the procedure.
  2. Preconditions and safety considerations.
  3. The exact commands or steps.
  4. What the procedure changes.
  5. How to verify success.
  6. Common failures and recovery steps.
  7. Relevant source files and related documentation.
  • Local development and environment setup
  • Architecture and data model
  • Operational runbooks
  • Deployments and releases
  • Billing and subscriptions
  • Storage, media, queues, and mail
  • Import and export formats
  • Scheduled maintenance
  • Testing and troubleshooting
  • New-maintainer onboarding