Technical Writing Ultimate Technical Writing 5 — Questions and Answers
Question 1: What does 'information architecture' mean in the context of technical documentation?
- The physical layout of an office where writers work
- The organization and structure of content so users can find and understand information efficiently (Correct answer)
- The database schema used to store documentation files
- The visual design system for a documentation website
Correct answer: The organization and structure of content so users can find and understand information efficiently
Information architecture refers to how content is organized, labeled, and navigated to support user findability and comprehension.
Question 2: When should a technical writer use a table instead of a bulleted list?
- When listing items with no relationship to each other
- When comparing multiple items across consistent attributes or categories (Correct answer)
- When writing a narrative explanation of a concept
- When documenting a step-by-step procedure
Correct answer: When comparing multiple items across consistent attributes or categories
Tables excel at presenting comparative or relational data where rows and columns reveal patterns across attributes.
Question 3: In the context of docs-as-code, what does treating documentation 'like code' primarily mean?
- Writing documentation in programming languages like Python
- Storing docs in version control, using pull requests for reviews, and automating publication (Correct answer)
- Letting developers write all documentation without writer review
- Publishing documentation only as executable scripts
Correct answer: Storing docs in version control, using pull requests for reviews, and automating publication
Docs-as-code applies software engineering workflows — version control, code review, and CI/CD pipelines — to documentation production.
Question 4: A user manual step reads: 'It may be necessary to restart the device.' What is the MAIN problem with this phrasing?
- It uses too many syllables
- It is vague and hedging — it should give a clear instruction like 'Restart the device.' (Correct answer)
- It should use passive voice instead
- It needs a warning label attached
Correct answer: It is vague and hedging — it should give a clear instruction like 'Restart the device.'
Hedging phrases like 'may be necessary' leave users uncertain about whether to act; direct imperatives remove ambiguity in procedures.
Question 5: What is the purpose of a 'glossary' in technical documentation?
- To list the authors and contributors to the document
- To define specialized terms, acronyms, and jargon used throughout the document (Correct answer)
- To provide an alphabetical index of topics covered
- To summarize the document's key conclusions
Correct answer: To define specialized terms, acronyms, and jargon used throughout the document
A glossary ensures readers share a common understanding of domain-specific or product-specific terminology used in the document.
Question 6: Which metric is MOST useful for evaluating the effectiveness of online help documentation?
- Total word count of the documentation
- Support ticket deflection rate (reduction in support contacts after users access docs) (Correct answer)
- Number of images included in the documentation
- Time it took writers to produce the documentation
Correct answer: Support ticket deflection rate (reduction in support contacts after users access docs)
Deflection rate measures whether documentation actually helps users solve problems independently, directly reflecting its effectiveness.
Question 7: A technical writer is asked to add a 'Note' callout to a procedure. When is a Note MOST appropriate?
- When the information could cause physical harm if ignored
- When providing supplementary information that helps the user but is not critical to completing the task (Correct answer)
- When the step is the most important step in the procedure
- When warning the user about data loss
Correct answer: When providing supplementary information that helps the user but is not critical to completing the task
Notes convey helpful supplementary information that enhances understanding without being safety-critical or required for task completion.
Technical Writing Ultimate Technical Writing 5
What does 'information architecture' mean in the context of technical documentation?