Understand the Diataxis documentation framework: tutorials, how-to guides, explanations, and reference documentation.
0 / 10 completed
1 / 10
In the Diataxis framework, a 'tutorial' is:
Tutorials are learning-oriented: the goal is skill building through guided practice. The learner follows steps to achieve a result they may not fully understand yet — understanding comes later.
2 / 10
A 'how-to guide' in Diataxis differs from a tutorial in that:
How-to guides address goals: how do I configure X? how do I deploy to Y? They assume the reader already has context — unlike tutorials which build context from scratch.
3 / 10
The 'explanation' (or 'discussion') document type in Diataxis is:
Explanations deepen understanding — they discuss why things work a certain way, explore alternatives, and provide conceptual context. Not for doing; for understanding.
4 / 10
Reference documentation in Diataxis is characterised by:
Reference docs are used to look things up: API parameters, configuration keys, command flags. They are accurate, complete, and consulted by people who already know what they need.
5 / 10
Which document type would describe 'why event-driven architecture was chosen over request-response' for a project?
Explaining architectural decisions and trade-offs is understanding-oriented content — it fits the explanation/discussion document type in Diataxis.
6 / 10
Sarah from the QA team just left a comment on your PR describing the new `UserSession` documentation. She says: 'This section doesn't clearly state how to handle expired sessions – it's confusing for users and needs more detail.' Which of the following best describes Sarah's concern regarding the Diataxis documentation?
Sarah's comment focuses on the lack of clarity regarding expired sessions. This directly relates to the 'how-to' aspect of Diataxis documentation – providing clear instructions and addressing potential user problems. The incorrect options misinterpret her feedback as concerns about architectural complexity or UI design; the core issue is a gap in the documentation itself, specifically around session management.
7 / 10
You're drafting the description for a Pull Request introducing a new API endpoint for retrieving user profiles. You want to use Diataxis documentation effectively. Which statement best reflects how you should approach describing this API?
The correct option provides a detailed description of the endpoint's function, format, and usage. It aligns with Diataxis's emphasis on providing precise technical information. Options A is too vague, B focuses on the general action but lacks specifics, C offers an overly verbose explanation, and D presents it as a generic solution without detailing the implementation.
8 / 10
Mark, the senior developer, left this Slack message: 'I'm struggling to find documentation on how to integrate with the EventProcessor module. Can someone point me to a good starting point?' Considering Diataxis's approach to documentation, what does Mark *most* need?
Mark needs a practical starting point – a tutorial. Diataxis documentation is designed to guide users through specific tasks with clear instructions. The other options provide more abstract or comprehensive information that isn't immediately helpful for someone just trying to get started with the EventProcessor module.
9 / 10
During a standup meeting, you're discussing your progress on documenting the new `OrderProcessing` service. A teammate asks: 'What kind of documentation are we aiming for?' Which statement best describes Diataxis's approach to documentation in this context?
Diataxis documentation prioritizes usability and practicality. The correct answer reflects a focus on 'how-to' guides that address developer needs – common scenarios, usage examples, and troubleshooting. Options A & B are too broad, while option D is far too minimal.
10 / 10
You're reviewing a PR that introduces a new feature: a real-time chat service. The PR description states: 'This feature utilizes WebSockets to enable bidirectional communication between clients and the server.' Within the Diataxis documentation framework, what *primary* purpose does this statement serve?
The statement clarifies the underlying technology – WebSockets – and explains *why* it was chosen. This provides crucial context for developers to understand how the feature works within the larger system. The other options are less relevant; legal disclaimers aren't typically part of documentation, architectural overviews can be detailed elsewhere, and UI elements are separate concerns.
This exercise, "Diataxis Documentation Framework", tests your understanding of technical writing vocabulary and phrasing through 10 multiple-choice questions drawn from real workplace scenarios.
Is this exercise free to use?
Yes. Every exercise on CoderSlingo, including this one, is completely free — no account, sign-up, or payment required.
How many questions does this exercise have?
This exercise has 10 questions. Each one presents a realistic sentence or scenario with multiple-choice options and an explanation once you answer.
What happens after I answer a question?
You'll see immediate feedback showing whether your answer was correct, along with a short explanation of why — then a button to move to the next question.
Can I retry the exercise if I get questions wrong?
Yes. Once you reach the results screen, click "Try again" to reset your answers and go through the exercise from the start as many times as you like.
Do I need to create an account to take this exercise?
No account is needed. Your answers are scored in your browser during the session — nothing is saved to a server, so you can jump straight in.
Is my progress saved if I leave the page?
No — progress within an exercise resets if you navigate away or reload. Each exercise is short enough to complete in a few minutes in one sitting.
Who is this Technical Writing exercise for?
It's designed for IT professionals and learners who want to sound natural discussing technical writing topics in English — useful for meetings, documentation, interviews, and day-to-day communication with English-speaking teams.
How is this different from reading a glossary or blog article?
Exercises like this one are active recall drills — you have to choose the correct term or phrasing yourself, which builds retention faster than passively reading a definition.
Where can I find more Technical Writing exercises?
Browse the full Technical Writing exercises hub for more practice, or explore other exercise categories covering vocabulary, grammar, interviews, and workplace communication.