Technical Writing Ultimate Technical Writing 4 — Questions and Answers
Question 1: What is the primary goal of 'task analysis' before writing a procedure?
- To estimate how long writing will take
- To identify and sequence every step a user performs to complete a task (Correct answer)
- To determine the document's page length
- To select the appropriate font for the procedure
Correct answer: To identify and sequence every step a user performs to complete a task
Task analysis breaks down the user's workflow into discrete, ordered steps so the writer can document the procedure accurately and completely.
Question 2: In DITA (Darwin Information Typing Architecture), what are the three core topic types?
- Overview, Reference, Tutorial
- Concept, Task, Reference (Correct answer)
- Introduction, Procedure, Glossary
- Guide, Manual, Specification
Correct answer: Concept, Task, Reference
DITA's core topic types are Concept (background knowledge), Task (step-by-step procedures), and Reference (look-up data like parameters or commands).
Question 3: When conducting a usability test on documentation, what is the MOST valuable data to collect?
- How many pages the document has
- Where users get stuck or confused while following the documentation (Correct answer)
- Whether users find the cover design attractive
- How fast users can read the document aloud
Correct answer: Where users get stuck or confused while following the documentation
Usability testing aims to reveal where users struggle, so the writer can revise unclear steps, missing information, or confusing structure.
Question 4: Which sentence BEST follows the 'one sentence, one idea' principle in technical writing?
- Click Save, then close the window, but first make sure you have entered your username, which is required for authentication, and the system will confirm the action.
- Click Save to store your changes. (Correct answer)
- The saving functionality, which is accessible via the toolbar or menu, persists user data.
- Users are advised that clicking the Save button, located in the upper-right corner, initiates the data persistence routine.
Correct answer: Click Save to store your changes.
Short, single-idea sentences reduce cognitive load and prevent misreading, especially in procedural steps.
Question 5: What is a 'release note' primarily intended to communicate?
- Detailed installation instructions for a new product
- A summary of new features, fixes, and known issues in a specific product version (Correct answer)
- Marketing messaging for a product launch
- The full technical specification of a system
Correct answer: A summary of new features, fixes, and known issues in a specific product version
Release notes inform users and stakeholders of what changed in a release, including new features, bug fixes, and any remaining known issues.
Question 6: A writer notices that the same term is used inconsistently — 'log in,' 'login,' and 'log-in' all appear. What is the BEST corrective action?
- Leave it as-is since minor inconsistencies are acceptable
- Choose one form, add it to the style guide, and update all instances throughout the document set (Correct answer)
- Use whichever form appears most frequently
- Ask the engineering team to pick the spelling
Correct answer: Choose one form, add it to the style guide, and update all instances throughout the document set
Standardizing terminology in the style guide and updating all occurrences ensures consistency and prevents user confusion.
Question 7: Which format is MOST appropriate for documenting a command-line tool's syntax?
- Numbered list with prose descriptions only
- Monospaced code block with placeholders in angle brackets or italics (Correct answer)
- Bulleted list with colloquial descriptions
- A table comparing it to a GUI alternative
Correct answer: Monospaced code block with placeholders in angle brackets or italics
Monospaced code formatting visually distinguishes commands from prose, and angle brackets or italics signal user-supplied values in CLI syntax documentation.
Technical Writing Ultimate Technical Writing 4
What is the primary goal of 'task analysis' before writing a procedure?