Mixed Deck — All Technical Writing Topics Flashcards

What is nominalization in technical writing?

Answer: Turning verbs into nouns

Nominalization (e.g., 'make a decision' instead of 'decide') weakens clarity and should be minimized.

What is the key benefit of using topic-based authoring in technical writing?

Answer: Each topic is self-contained and can be reused in multiple documents

Topic-based authoring creates modular, standalone content units that can be assembled into different deliverables without rewriting.

Today, the ___________________ is quite helpful for providing business reports.

Answer: MS PowerPoint

MS PowerPoint is widely used today for presenting business reports due to its versatility in combining text, visuals, and multimedia elements. It allows for structured presentations that can effectively convey complex information in an engaging and digestible format. Its features facilitate clear communication, professional delivery, and audience comprehension of reports.

The demonstrates the benefits and drawbacks of the suggested business venture and the current operation.

Answer: feasibility studies

Feasibility studies are conducted to assess the practicality and viability of a proposed project or business venture. They thoroughly analyze potential benefits, drawbacks, risks, and resource requirements, often comparing them to current operations or alternatives. This helps decision-makers determine if a project is worth pursuing by providing a comprehensive overview of its potential success and challenges.

When writing error messages in US software documentation, which tone is recommended?

Answer: Helpful and non-blaming

Error messages should be constructive and non-blaming, guiding the user to a solution without frustration.

What does 'alt text' (alternative text) provide in technical documentation?

Answer: A text description of an image for accessibility and screen readers

Alt text provides a textual description of images, enabling users with visual impairments to understand image content via screen readers and improving document searchability.

Which type of feedback method involves watching real users attempt tasks with documentation?

Answer: Usability testing

Usability testing observes real users attempting tasks, revealing exactly where documentation confuses or fails them.

What does a content management system (CMS) help technical writers manage?

Answer: Storage, organization, versioning, and publishing of documentation content

A CMS centralizes content creation, versioning, workflow, and publication, making large documentation sets manageable.

What is progressive disclosure in documentation design?

Answer: Presenting basic information first, then revealing complexity as users need it

Progressive disclosure layers information so users are not overwhelmed, encountering complexity only when they are ready.

Which document type describes the overall system architecture for a software project?

Answer: System Architecture Document (SAD)

A System Architecture Document describes the high-level design, components, and interactions of a software system.

What is the role of an information architect in a documentation team?

Answer: Organize content structure, navigation, and findability

An information architect designs how content is categorized, labeled, and navigated to maximize user findability.

The first step was spent drafting instructions and was thought of as:

Answer: Clarifying the audience

Before drafting any instructions, the most critical first step is to clarify the audience. Understanding who will be reading the instructions—their background, technical expertise, and purpose—allows the writer to tailor the language, level of detail, and format appropriately. This ensures the instructions are effective, user-friendly, and meet the specific needs of the users.

What is the difference between editing and proofreading?

Answer: Editing addresses content and structure; proofreading catches surface errors

Editing improves clarity, organization, and completeness, while proofreading catches typos, punctuation, and formatting errors.

Pick the incorrect assertion regarding writing:

Answer: Your writing ability will never affect your job performance.

The assertion that your writing ability will never affect your job performance is incorrect. Strong writing skills are critical in nearly all professional roles, impacting communication clarity, efficiency, and professional credibility. Effective written communication, whether in emails, reports, or presentations, directly influences how well you convey ideas and perform your duties.

What is the benefit of creating a user journey map for documentation planning?

Answer: It shows all the touchpoints where users need information across their experience

A user journey map reveals every moment where documentation can support or fail the user, guiding prioritization.

Which document is created to explain how two parties must fulfill agreed-upon service levels?

Answer: Service Level Agreement (SLA)

An SLA defines measurable service commitments, responsibilities, and penalties between a provider and client.

Which type of list is best for sequential steps?

Answer: Numbered list

Numbered lists convey order and sequence, making them ideal for step-by-step procedures.

What is minimalism in technical writing (after John Carroll)?

Answer: Giving users only what they need to complete tasks, minimizing unnecessary content

Carroll's minimalism principle advocates task-oriented content that reduces noise and lets users achieve goals quickly.

What distinguishes a tutorial from a how-to guide?

Answer: Tutorials teach concepts through learning goals; how-tos solve a specific task

Tutorials build understanding progressively, while how-to guides are task-focused and assume the user knows what they want.

What reading behavior do studies show most users of technical documents exhibit?

Answer: Scanning rather than reading linearly

Eye-tracking studies show that users scan headings, bullets, and bold text before deciding what to read in depth.