Manuals / Documentation Systems / Ch 3

A · StructureBeginner35 min read

3. READMEs that onboard

Documentation Systems · 36 pages source format

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

What you'll learn

  • README anatomy
  • Quickstart test

README rewrite

# 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.

Clear?

Checklist