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:
- When and why to use the procedure.
- Preconditions and safety considerations.
- The exact commands or steps.
- What the procedure changes.
- How to verify success.
- Common failures and recovery steps.
- Relevant source files and related documentation.
Planned handbook areas
Section titled “Planned handbook areas”- 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