CPW Technical Writing and Documentation 1 — Questions and Answers
Question 1: What is the primary purpose of a technical specification document?
- To entertain the reader with industry stories
- To define the requirements and design of a system or product in precise detail (Correct answer)
- To summarize company history for new employees
- To provide general writing style guidelines
Correct answer: To define the requirements and design of a system or product in precise detail
A technical specification document precisely defines system requirements, design decisions, and implementation details so developers and stakeholders share a common understanding.
Question 2: Which document structure best suits step-by-step instructions for end users?
- Narrative prose with embedded bullet points
- Numbered sequential steps with clear action verbs (Correct answer)
- Dense paragraphs with footnotes
- Abstract theoretical overview followed by an index
Correct answer: Numbered sequential steps with clear action verbs
Numbered sequential steps with action verbs (e.g., 'Click,' 'Enter,' 'Select') guide users through procedures without ambiguity.
Question 3: In technical writing, what does 'minimalism' refer to?
- Using the fewest words possible regardless of clarity
- Providing only the information users need to complete tasks, reducing cognitive load (Correct answer)
- Avoiding all graphics and visuals
- Writing documentation without a table of contents
Correct answer: Providing only the information users need to complete tasks, reducing cognitive load
Technical writing minimalism means delivering task-oriented content that lets users accomplish goals quickly without excess information or lengthy explanations.
Question 4: What is a 'style guide' in the context of technical documentation?
- A fashion magazine for office professionals
- A set of standards for writing and formatting that ensures consistency across documents (Correct answer)
- A glossary of technical jargon
- A list of banned words and phrases
Correct answer: A set of standards for writing and formatting that ensures consistency across documents
A style guide establishes consistent standards for terminology, formatting, tone, and structure so all documentation within an organization reads uniformly.
Question 5: Which of the following best describes an API reference document?
- A marketing brochure for software products
- A technical document listing endpoints, parameters, return values, and usage examples for developers (Correct answer)
- A high-level overview of a company's technology strategy
- A tutorial for non-technical business users
Correct answer: A technical document listing endpoints, parameters, return values, and usage examples for developers
An API reference document provides developers with precise details about endpoints, request/response formats, authentication, and code examples needed to integrate a service.
Question 6: What is the role of 'plain language' in technical writing?
- To avoid using any technical terminology under all circumstances
- To communicate complex information clearly so readers can understand and act on it with ease (Correct answer)
- To write documentation that only experts can comprehend
- To replace all diagrams with text descriptions
Correct answer: To communicate complex information clearly so readers can understand and act on it with ease
Plain language in technical writing means using clear, direct prose so readers—regardless of background—can quickly understand and apply the information.
CPW Technical Writing and Documentation 1
What is the primary purpose of a technical specification document?