Punctuation, Lists, and Formatting in Technical Writing (English)
Practice correct punctuation, list formatting, and typographic conventions in technical documentation.
0 / 8 completed
1 / 8
When should you use a bulleted list vs. a numbered list?
Numbered lists imply order or sequence — use them for procedures where steps must be followed in order. Bulleted lists are for unordered collections. Using bullets for a 5-step installation process suggests the order does not matter, which is misleading.
2 / 8
What is the correct way to introduce a list in technical writing?
List introductions should be complete sentences or phrases that end with a colon. 'The following:' is incomplete. 'Options:' as a header is fine for reference docs but less clear for prose. 'The configuration supports the following options:' is complete and clear.
3 / 8
How should parallel structure work in a bulleted list?
Parallel structure: if item 1 starts with a verb ('Configure the...'), all items should start with verbs. Mixing forms ('Configure the firewall', 'Authentication', 'You should update the certs') is jarring and harder to scan.
4 / 8
What punctuation appears at the end of list items in most technical writing style guides?
Style guide consensus: full sentences in a list get periods. Fragments ('User authentication', 'Rate limiting', 'Audit logging') typically get no punctuation. The key is consistency — do not mix periods and no punctuation within the same list.
5 / 8
How do you correctly write a range of numbers in technical documentation?
Ranges: 'from X to Y' in prose ('from 2 to 4 weeks'); en dash in technical references ('1–100 users', '30–60 seconds'). A hyphen instead of an en dash is technically incorrect but widely accepted. 'Thru' is informal and should be avoided in professional docs.
6 / 8
What does 'non-breaking space' prevent in technical documentation?
Non-breaking spaces ( in HTML) prevent awkward line breaks in technical docs: '500 MB', '2.3 GHz', 'Version 2.0'. Without them, the unit or version number can appear orphaned on the next line.
7 / 8
What is the 'em dash' (—) and when should it be used in technical writing?
Em dashes create emphasis and interrupt flow. 'This function — unlike its predecessor — handles edge cases correctly' gives more emphasis than parentheses. Use sparingly; overuse diminishes impact.
8 / 8
What is 'code inline' vs 'code block' formatting in technical documentation?
Inline code (backticks) is used for function names, variables, file paths, and short commands within prose. Code blocks (fenced) are for multi-line code, terminal sessions, and complete examples that the reader might copy. Clear formatting signals what is executable and what is explanation.