Back to routines

Docs Edit Pass

by PixelBadger Creative Production › Editing

Start routine

50 minutes 6 Steps

  1. Prepare

    • Open the doc in a different font or on a different screen to see it fresh
    • Write down who the doc is for

  2. Accuracy pass

    20 minutes

    Run every command and code sample from scratch. Fix anything that breaks.

  3. Break

    5 minutes

  4. Clarity pass

    15 minutes

    Cut jargon, keep one idea per sentence, and use the imperative for instructions: run, not you can run.

  5. Scannability pass

    10 minutes

    Headings as tasks, numbered lists for steps, and warnings in bold.

  6. Final checks

    • Every link works
    • Screenshots match the current UI
    • Spelling and grammar checked