Technical Writing Ultimate Technical Writing 2 — Questions and Answers
Question 1: Which document type is BEST suited for capturing agreed-upon system behaviors between stakeholders and developers?
- User manual
- Software Requirements Specification (SRS) (Correct answer)
- Release notes
- Style guide
Correct answer: Software Requirements Specification (SRS)
An SRS formally documents functional and non-functional requirements agreed upon by stakeholders and the development team.
Question 2: When writing API documentation, what should a 'Parameters' section always include?
- Marketing copy about the API's benefits
- Data type, required/optional status, and description for each parameter (Correct answer)
- A list of competing APIs
- The internal variable names used by developers
Correct answer: Data type, required/optional status, and description for each parameter
Parameter tables must specify data type, whether the parameter is required or optional, and a clear description so developers can integrate correctly.
Question 3: A technical writer is simplifying a 500-page legacy manual. Which strategy should they apply FIRST?
- Reformat all fonts and margins
- Conduct a content audit to identify outdated or redundant sections (Correct answer)
- Translate the document into multiple languages
- Add more screenshots
Correct answer: Conduct a content audit to identify outdated or redundant sections
A content audit identifies what is accurate, outdated, redundant, or missing before any revision work begins.
Question 4: In minimalism (as a technical writing approach), which principle is most central?
- Include exhaustive background theory so users understand context
- Focus on tasks users actually perform, omitting unnecessary explanation (Correct answer)
- Use passive voice to maintain objectivity
- Add warnings to every procedural step
Correct answer: Focus on tasks users actually perform, omitting unnecessary explanation
Minimalism prioritizes task-oriented content, cutting theory and background that does not directly support what the user needs to do.
Question 5: What is the primary purpose of a 'Changelog' in software documentation?
- To describe the product's future roadmap
- To record what changed, was added, or was fixed across versions (Correct answer)
- To list known bugs with no fix
- To provide installation instructions for new users
Correct answer: To record what changed, was added, or was fixed across versions
A changelog gives users and developers a chronological record of modifications between versions of a product.
Question 6: Which of the following is the BEST example of active voice in technical writing?
- The file is saved by the system automatically.
- The system automatically saves the file. (Correct answer)
- It is recommended that files be saved.
- Files should be saved by users regularly.
Correct answer: The system automatically saves the file.
Active voice places the subject performing the action first, making sentences clearer and more direct.
Question 7: When creating a user guide for an international audience, which practice is MOST important?
- Use idioms to make the text feel conversational
- Avoid culture-specific examples and use plain, neutral language (Correct answer)
- Write only in formal British English
- Include as many abbreviations as possible to save space
Correct answer: Avoid culture-specific examples and use plain, neutral language
Neutral, plain language without idioms or culture-specific references ensures the content translates accurately and is understood globally.
Technical Writing Ultimate Technical Writing 2
Which document type is BEST suited for capturing agreed-upon system behaviors between stakeholders and developers?