Practice & Assessment
Test your understanding of Documentation Fundamentals
Multiple Choice Questions
6A developer writes a document that explains step-by-step how to deploy an app but also includes deep background on why the deployment architecture was chosen. According to the Diátaxis framework, what is the problem?
Which of the following best demonstrates the imperative mood in technical documentation?
What is the primary purpose of the docs-as-code philosophy?
Which phrase should you remove from developer documentation and why?
A new team member joins and can't complete a task using your existing documentation. Which question best diagnoses the root cause?
In docs-as-code, what is the correct handling of a factual error found in documentation?
Coding Challenges
1Classify and Rewrite a Mixed Documentation Page
You are given a 300-word documentation page that incorrectly mixes a how-to guide with background explanation. Input: the mixed text. Task: (1) identify which sentences belong to a how-to vs. explanation, (2) rewrite it as two separate, properly-typed documents — one how-to and one explanation — each between 100–150 words, (3) apply all style rules: active voice, imperative mood for steps, second person, sentences under 25 words. Output: two labeled Markdown documents. Constraint: no sentence from the original may be copied verbatim. Estimated time: 20–25 minutes.
Mini Project
Documentation Audit and Style Guide
Take any open-source project on GitHub with weak documentation (at least 3 obvious issues). Conduct a full documentation audit: (1) classify every existing doc page using the Diátaxis framework, (2) write a 1-page audience persona document for the project, (3) identify 5 style violations and rewrite those sentences following the style rules from this module, (4) create a project-specific terminology glossary with at least 8 terms. Deliver everything as a single Markdown file using proper heading hierarchy, code blocks where applicable, and a table for the terminology glossary.