Technical Writing Document Types 2 — Questions and Answers
Question 1: Which document type is used to formally request services or products from vendors?
- Request for Proposal (RFP) (Correct answer)
- User manual
- Style guide
- Release note
Correct answer: Request for Proposal (RFP)
An RFP outlines an organization's needs and invites vendors to submit bids or proposals.
Question 2: What is an API reference document?
- Technical documentation describing endpoints, parameters, and responses (Correct answer)
- A marketing summary of software features
- A troubleshooting guide
- A licensing agreement
Correct answer: Technical documentation describing endpoints, parameters, and responses
An API reference provides developers with the technical details needed to integrate with a software interface.
Question 3: Which document is created to explain how two parties must fulfill agreed-upon service levels?
- Service Level Agreement (SLA) (Correct answer)
- Feasibility study
- User story
- Installation guide
Correct answer: Service Level Agreement (SLA)
An SLA defines measurable service commitments, responsibilities, and penalties between a provider and client.
Question 4: What is the purpose of a troubleshooting guide?
- Help users diagnose and resolve common problems (Correct answer)
- Train new staff on procedures
- Document system architecture
- Define coding standards
Correct answer: Help users diagnose and resolve common problems
A troubleshooting guide presents symptoms, causes, and solutions to help users fix known issues independently.
Question 5: Which document type describes the overall system architecture for a software project?
- System Architecture Document (SAD) (Correct answer)
- Release note
- Quick start guide
- Glossary
Correct answer: System Architecture Document (SAD)
A System Architecture Document describes the high-level design, components, and interactions of a software system.
Question 6: What is a quick start guide's goal?
- Get the user productive fast with minimal reading (Correct answer)
- Replace the full user manual
- Document all product features
- Provide legal warranties
Correct answer: Get the user productive fast with minimal reading
A quick start guide focuses on the minimum steps needed for a user to begin using a product immediately.
Technical Writing Document Types 2
Which document type is used to formally request services or products from vendors?