CPW Technical Writing and Documentation 2 — Questions and Answers
Question 1: A user manual should be organized primarily around which principle?
- How the product was built
- The tasks users need to accomplish (Correct answer)
- The development team's internal workflow
- Alphabetical listing of all features
Correct answer: The tasks users need to accomplish
Effective user manuals are task-oriented, organizing content around what users need to do rather than how the product was engineered.
Question 2: What distinguishes a 'warning' from a 'caution' in technical documentation?
- Warnings address potential injury to persons; cautions address potential damage to equipment or data (Correct answer)
- They are interchangeable and mean the same thing
- Cautions are more serious than warnings in all contexts
- Warnings apply only to software; cautions apply only to hardware
Correct answer: Warnings address potential injury to persons; cautions address potential damage to equipment or data
In ANSI/ISO safety labeling standards, 'Warning' signals risk of personal injury, while 'Caution' signals risk of equipment damage or data loss.
Question 3: Which element is most critical when writing release notes for software?
- Extensive biographical information about the development team
- Clear descriptions of new features, bug fixes, and known issues grouped by version (Correct answer)
- Marketing language emphasizing product superiority
- Historical context about the company's founding
Correct answer: Clear descriptions of new features, bug fixes, and known issues grouped by version
Release notes must concisely communicate changes per version—new features, resolved bugs, and known issues—so users and developers know exactly what changed.
Question 4: What is 'single-sourcing' in technical documentation?
- Using one writer to produce all documents
- Creating content once and reusing it across multiple outputs (PDF, web, help system) from a single source file (Correct answer)
- Limiting research to a single reference material
- Publishing documentation on only one platform
Correct answer: Creating content once and reusing it across multiple outputs (PDF, web, help system) from a single source file
Single-sourcing lets technical writers maintain one master content file that automatically publishes to multiple formats, reducing duplication and update errors.
Question 5: When documenting a complex process, flowcharts are most useful for:
- Replacing all written instructions entirely
- Visualizing decision points, sequences, and branching paths that are hard to convey in prose (Correct answer)
- Adding decorative elements to break up text
- Satisfying legal documentation requirements
Correct answer: Visualizing decision points, sequences, and branching paths that are hard to convey in prose
Flowcharts excel at mapping conditional logic, branching workflows, and sequential steps visually so readers can grasp the overall process at a glance.
Question 6: What does 'version control' mean for technical documentation?
- Controlling how many users can view a document simultaneously
- Tracking changes to documents over time so previous versions can be retrieved and differences reviewed (Correct answer)
- Limiting document length to a specific page count
- Controlling the font version used across all files
Correct answer: Tracking changes to documents over time so previous versions can be retrieved and differences reviewed
Version control systems (e.g., Git) track document history, allowing writers to review changes, revert to earlier drafts, and collaborate without overwriting each other's work.
CPW Technical Writing and Documentation 2
A user manual should be organized primarily around which principle?