Write a runbook for a task your team rarely does

Writes the steps for a manual task into your docs, checked against how your product really works.

Get started for free

What you ask

Search Acme

operations

2

  1. Tom

    @devboxes we resend failed invoice emails by hand every few weeks and look up the steps again every time. can you write a runbook?

  2. devboxes APP

    #67 adds it as docs/runbooks/resend-invoice-emails.md. Five steps, from finding the failed sends to confirming the resend in the send log.

    Opened #67

What devboxes does

  1. Pin down the task

    • devboxes makes sure it knows the task and where the runbook should live.

  2. Work out the steps from the code

    • Each step is backed by the code or a script, with references to the files.

  3. Write the runbook

    • The runbook covers every section, and every command in it exists in the repository or its tools.

  4. Verify

    1. Install dependencies

    2. Test

    3. Lint

    4. If it fails

      1. Fix

        • The tests pass.

      2. Test again

      3. Lint again

  5. Publish

  6. Review

Good for

Startups

More tasks to cut admin

Ask devboxes to write a runbook for a task your team rarely does

Get started for free