Technical Writing Ultimate Technical Writing 3 — Questions and Answers
Question 1: What distinguishes a 'warning' from a 'caution' in ANSI Z535 safety notice standards?
- There is no difference; the terms are interchangeable
- Warning indicates risk of death or serious injury; caution indicates risk of minor injury or equipment damage (Correct answer)
- Caution indicates risk of death; warning indicates risk of equipment damage
- Warning is for software; caution is for hardware
Correct answer: Warning indicates risk of death or serious injury; caution indicates risk of minor injury or equipment damage
ANSI Z535 defines Warning as hazards that could result in death or serious injury, while Caution covers potential minor injury or property damage.
Question 2: A technical writer needs to document a REST API endpoint. Which element is LEAST necessary in the endpoint description?
- HTTP method (GET, POST, etc.)
- Request and response schema
- The developer's name who built the endpoint (Correct answer)
- Authentication requirements
Correct answer: The developer's name who built the endpoint
The endpoint developer's identity is irrelevant to users integrating the API; what matters are the method, schema, and auth requirements.
Question 3: Which writing technique helps readers scan a long technical document most effectively?
- Writing in dense paragraphs with no breaks
- Using headers, subheaders, bullet lists, and white space (Correct answer)
- Avoiding any use of bold or italics
- Writing all content as continuous prose
Correct answer: Using headers, subheaders, bullet lists, and white space
Chunking content with headers, lists, and white space allows readers to scan and locate relevant sections quickly.
Question 4: In documentation, what is 'single sourcing'?
- Citing only one reference per document
- Writing content once and reusing it across multiple outputs or formats (Correct answer)
- Having one writer responsible for all documentation
- Publishing documentation on a single platform only
Correct answer: Writing content once and reusing it across multiple outputs or formats
Single sourcing means creating content once in a source file (often XML or DITA) and publishing it to multiple formats like PDF, HTML, and help systems.
Question 5: What is the role of a 'style guide' in a technical writing team?
- To teach writers how to use desktop publishing software
- To ensure consistency in terminology, tone, formatting, and usage across all documents (Correct answer)
- To track document version history
- To define the project budget for documentation
Correct answer: To ensure consistency in terminology, tone, formatting, and usage across all documents
A style guide standardizes language and formatting decisions so all documents from a team feel cohesive and professional.
Question 6: Which approach BEST supports accessibility in technical documentation?
- Using only color to convey critical information
- Providing alt text for images and ensuring sufficient color contrast (Correct answer)
- Writing all text in italics for emphasis
- Using PDFs exclusively to lock formatting
Correct answer: Providing alt text for images and ensuring sufficient color contrast
Alt text makes images accessible to screen readers, and adequate color contrast supports users with visual impairments.
Question 7: A technical writer is asked to write a 'quick reference card.' What is its defining characteristic?
- It covers every feature of the product in full detail
- It provides only the most essential steps or commands on a single page or card (Correct answer)
- It replaces the full user manual entirely
- It is intended only for system administrators
Correct answer: It provides only the most essential steps or commands on a single page or card
A quick reference card is a compact, single-page summary of the most critical or frequently used information for fast lookup.
Technical Writing Ultimate Technical Writing 3
What distinguishes a 'warning' from a 'caution' in ANSI Z535 safety notice standards?