Learning on Web Dev Open is free for all.

Systems Thinking > Ship something other people installThe README is part of the API
Phase 03Ship something other people install181 of 434

The README is part of the API

Thirty seconds to the first working line, then the honest section about what this deliberately does not do.

Solo project70 minAI adversary

Done when

  • A copy-pasteable example above the fold that works unmodified
  • Every exported function documented with a real example, not a signature
  • A section on what this does not do and what to use instead
  • A changelog with at least one entry written for the person upgrading

Nobody marks this for you. It goes into your phase checkpoint, where a person does.

You should now be able to

  • Write documentation that a stranger can act on immediately
  • State the limitations before someone discovers them
Ask the community

Loading…

← PreviousShip it where someone can install itShip something other people installNext →Write up the bug that taught you somethingCheckpoint: Systems Thinking