Role-Specific Writing
9 exercises — one writing challenge for each engineering role: Frontend, Backend, Mobile, DevOps/SRE, QA, Data Science, Technical Writing, Security, and Product Management.
0 / 9 completed
Writing for your role
- Frontend / Backend: Code comments explain why, not what. API docs show examples.
- Mobile: App Store notes are user-facing — feature + benefit + where to find it
- DevOps/SRE: Runbooks need exact commands + verification steps + escalation paths
- QA: Test cases need preconditions, exact inputs, and measurable expected results
- Data / Security / PM: Translate technical findings into actionable business language for mixed audiences
1 / 9
Frontend — JSDoc comment
A React component accepts props for a form field. Which JSDoc comment is written most effectively?
// [COMMENT HERE]
function TextField({ label, value, onChange, error, disabled = false }) {
...
}Option B is the professional standard. Each param has: type annotation, name, and a description that explains the behaviour (not just the type). Optional params are marked with
[]. Default values are noted. The error param description explains what happens when the value is present ("renders below field in red") — this is behavioural documentation that tooling can't infer from the type. Option A is one sentence with no params. Option C is a flat list with no types or behavioural descriptions. Option D has types but descriptions that just repeat the param name — "label label" tells the next developer nothing. All writing exercises complete! Browse all exercises →