Documentation Writing
3 exercises — write helpful README sections, add meaningful code comments, and simplify overly complex technical prose.
0 / 3 completed
Documentation principles
- README sections: State pre-requisites · use fenced code blocks · show verification steps · note platform gotchas
- Code comments: Explain why and what the algorithm does, not what each function call does
- Clarity: Prefer active voice · use imperative mood for instructions · remove words that add length without meaning
- API docs: Always show a concrete example developers can copy
1 / 3
You're writing the Installation section of a README for a Node.js CLI tool. Which version is the most useful for other developers?
Option B is the standard. It states the pre-requisites up front (Node ≥ 18, npm ≥ 9), provides the install command in a fenced code block, includes a verification step with expected output, and adds a platform-specific note for macOS users. Option A is vague ("configure it", "right version"). Option C works but omits pre-requisites, verification, and platform gotchas. Option D is condescending ("the usual stuff") and provides no actual commands.
Next up: User Stories →