Pathwise

Manuals / Documentation Systems / Chapter 3

A · Structure · beginner · ~35 min · Chapter 3 of 9

READMEs that onboard

What is this, why, quickstart, how to test, where to learn more. Link deep docs — don’t paste novels.

Path progress
33%

Step 1 of 1

README rewrite

README rewriteDrag stickies · tap for tips
Study mapDrag stickies · tap for tipsKeep it shortdrag · tap →Name the waitdrag · tap →Scope locatorsdrag · tap →Trace when stuckdrag · tap →One browser firstdrag · tap →Isolate statedrag · tap →Assert the UIdrag · tap →Retry wiselydrag · tap →Seed datadrag · tap →Close the loopdrag · tap →Keep it shortdrag · tap →Name the waitdrag · tap →Scope locatorsdrag · tap →Trace when stuckdrag · tap →One browser firstdrag · tap →Isolate statedrag · tap →Pathwise hackdrag · tap →README rewritedrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

Example

# Name
What / why
## Quickstart
## Develop
## Test
## Config
## Troubleshoot
## Deeper docs

Do this now

Rewrite one README. Have a peer onboard from zero using only it.

Was this step clear?
Chapter learning outcomes
  • README anatomy
  • Quickstart test

Clear these before you leave