Writing Process Flashcards

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.

What is a content audit in technical writing?

Answer: Systematic review of existing documentation to assess accuracy and gaps

A content audit evaluates existing docs for accuracy, completeness, relevance, and alignment with current product features.

Which tool type do technical writers use to manage structured content reuse?

Answer: Component Content Management System (CCMS)

A CCMS stores content as reusable components that can be assembled into multiple deliverables, enabling single-sourcing.

What is the purpose of a writing template in technical documentation?

Answer: Provide a consistent structure for a recurring document type

Templates standardize structure and formatting so writers can focus on content rather than document design each time.

At what stage should usability testing of documentation occur?

Answer: Before final publication, ideally with real users

Usability testing with real users before publication reveals where documentation fails to meet user needs.

What does version control for documentation help teams do?

Answer: Track changes, collaborate, and revert to previous versions

Version control (e.g., Git) lets documentation teams track revisions, manage contributions, and recover previous document states.