Back to routines

README-First Design

by PixelBadger Creative Production › Deep Drafting

Start routine

30 minutes 6 Steps

  1. Set up

    • A blank README.md
    • One sentence on the problem it solves

  2. What it is

    5 minutes

    Two or three sentences a stranger would understand.

  3. Usage examples

    15 minutes

    Write the commands or code you wish you could type. This is the design.

  4. Installation

    5 minutes

  5. Limitations and non-goals

    5 minutes

    What it deliberately won't do.

  6. Review

    • Could a stranger get started from this alone?
    • Is every example something you'd want to type?
    • Is anything in there you can cut from version one?