CraftBeginner35 min read
2. Example first
Writing Better Documentation · 12 pages source format
Show the happy path command or snippet before the theory.
What you'll learn
- Examples
- Failure modes
Copy-pasteable wins
If someone can’t paste and succeed, the doc failed. Include expected output.
## Goal
## Prerequisites
## Steps
## Expected result
## If it failsDo this now
Rewrite one paragraph as numbered steps + expected result.
Clear?