Technical Writing Diagnostic 4 — Questions and Answers
Question 1: What does 'single-sourcing' mean in technical documentation?
- Writing a document using only one reference
- Creating content once and reusing it across multiple outputs or formats (Correct answer)
- Assigning one writer per document
- Using a single font throughout all documents
Correct answer: Creating content once and reusing it across multiple outputs or formats
Single-sourcing allows writers to maintain one master content set that publishes to multiple formats, reducing duplication and errors.
Question 2: A procedure step reads: 'It may be necessary to restart the application.' What is wrong with this instruction?
- It is too short
- It is vague and not action-oriented; users need a clear directive (Correct answer)
- It uses the wrong verb tense
- It should be a bulleted item, not a numbered step
Correct answer: It is vague and not action-oriented; users need a clear directive
Effective procedure steps use direct, imperative language such as 'Restart the application' to remove ambiguity.
Question 3: Which document structure technique helps users navigate a long technical report most effectively?
- Writing all content in one continuous paragraph
- Using clear headings, a table of contents, and an index (Correct answer)
- Avoiding page numbers to reduce clutter
- Placing all figures at the end of the document
Correct answer: Using clear headings, a table of contents, and an index
Headings, a table of contents, and an index give users multiple navigation paths to find information quickly.
Question 4: What is the MAIN difference between a process description and a procedure?
- A process description is always shorter than a procedure
- A process description explains how something works; a procedure tells users how to do something (Correct answer)
- A procedure is only used in engineering documents
- A process description always includes safety warnings
Correct answer: A process description explains how something works; a procedure tells users how to do something
Process descriptions are informational, explaining a mechanism or sequence; procedures are instructional, directing user actions.
Question 5: Which of the following BEST describes the concept of 'progressive disclosure' in documentation design?
- Revealing all technical details on the first page
- Presenting basic information first, then offering access to more detail as needed (Correct answer)
- Disclosing security vulnerabilities in product documentation
- Using increasingly large font sizes throughout the document
Correct answer: Presenting basic information first, then offering access to more detail as needed
Progressive disclosure prevents cognitive overload by layering information, giving users depth only when they seek it.
Question 6: When is it appropriate to use a table in technical documentation?
- When presenting a single data point
- When comparing multiple items across consistent attributes or displaying structured data (Correct answer)
- When describing an emotional user experience
- When the document has no headings
Correct answer: When comparing multiple items across consistent attributes or displaying structured data
Tables efficiently organize comparative or multi-attribute data, enabling quick scanning and direct comparison.
Question 7: What is 'plain language' in the context of US government and technical writing standards?
- Writing at a first-grade reading level regardless of audience
- Writing clearly and concisely so the intended audience can understand and act on it the first time they read it (Correct answer)
- Avoiding all technical terms in any document
- Using only one-syllable words
Correct answer: Writing clearly and concisely so the intended audience can understand and act on it the first time they read it
Plain language is defined by the Plain Writing Act as clear, organized writing that meets the needs of the intended audience.
What does 'single-sourcing' mean in technical documentation?