Before you start
What you should know#
Fill this in: the honest minimum. Naming it stops the wrong people spending a frustrating afternoon, and reassures the right ones.
What you need installed#
| Tool | Version | Why |
|---|---|---|
State the versions this series is tested against and when you last checked. Most "this tutorial is broken" reports are a major version released after it was written, and the reader has no way to tell.
How long it takes#
| Part | Doing it | Reading it |
|---|---|---|
| Part 1 — Set up | ||
| Part 2 — Build | ||
| Part 3 — Ship |
Measure these once on a clean machine rather than estimating them. Learners plan their evening around this table.
What you will end up with#
Describe the finished result in two sentences, and say what it deliberately does not do. A reader who knows the destination reads the middle differently — and nobody arrives disappointed at a scope that was stated up front.
Where to ask#
Name the place, and say what a good question includes: the command, the exact error, and what you already tried.