Technical Writing Writing Process 3

Question 1

What is the 'docs as code' approach in technical writing?

Accepted Answer

Treating documentation like software: stored in Git, reviewed via PRs, built with pipelines

Answer

Docs as code applies software development workflows—version control, CI/CD, peer review—to documentation production.

Question 2

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

Accepted Answer

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

Answer

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

Question 3

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

Accepted Answer

Organize content structure, navigation, and findability

Answer

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

Question 4

What does peer review in technical writing involve?

Accepted Answer

A fellow writer reviewing the document for clarity and structure

Answer

Peer review has another technical writer evaluate the document for readability, structure, and adherence to style guidelines.

Question 5

Which metric best measures whether technical documentation is effective?

Accepted Answer

Task completion rate in usability tests

Answer

Task completion rate—whether users can successfully perform tasks using the documentation—directly measures effectiveness.

Technical Writing Practice Test