Pathwise

Manuals / Portfolio That Hires / Chapter 2

A · Build proof · beginner · ~35 min · Chapter 2 of 5

README as sales page

Problem, approach, how to run, architecture sketch, sample report. Assume zero Slack access.

Path progress
40%

Step 1 of 1

Write the README

Top: what it is + why. Then quickstart. Then design choices. Then limitations.

Write the READMEDrag 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 →Write the READMEdrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

Do this now

Ship a README someone else can run in 15 minutes.

Pro tip: A diagram beats three paragraphs of folder poetry.

Was this step clear?
Chapter learning outcomes
  • README structure
  • Screenshots / GIFs
  • Honest scope

Clear these before you leave