text stringlengths 1.69k 13.6k | file stringlengths 9 25 |
|---|---|
Who’s using Diátaxis? ¶ At Gatsby we recently reorganized our open-source documentation, and the Diátaxis framework was our go-to resource throughout the project. The four quadrants helped us prioritize the user’s goal for each type of documentation. By restructuring our documentation around the Diátaxis framework, we ... | adoption.txt |
Colofon ¶ Diátaxis is the work of Daniele Procida. The principles described in this website have been developed over a number of years, and continue to be elaborated and explored. Origins and development ¶ The original context for this approach was software product documentation, which remains their principal applicati... | colofon.txt |
The compass ¶ The Diátaxis map is an effective reminder of the different kinds of documentation and their relationship, and it accords well with intuitions about documentation. However intuition is not always to be relied upon. Often when working with documentation, an author is faced with the question: what form of do... | compass.txt |
Diátaxis in complex hierarchies ¶ The basics ¶ The application of Diátaxis to most documentation is fairly straightforward. The product that defines the domain of concern has clear boundaries, and it’s possible to come up with a simple arrangement of its contents according to the principles, for example: home <- landin... | complex-hierarchies.txt |
Colofon ¶ Diátaxis is the work of Daniele Procida. The principles described in this website have been developed over a number of years, and continue to be elaborated and explored. Origins and development ¶ The original context for this approach was software product documentation, which remains their principal applicati... | diataxis.fr.txt |
About explanation ¶ Explanation is discussion that clarifies and illuminates a particular topic. Explanation is understanding-oriented\. Explanation clarifies, deepens and broadens the reader’s understanding of a subject. It’s not concerned with what the user might be doing, like tutorials and how-to guides. It’s not a... | explanation.txt |
About how-to guides ¶ How-to guides are directions that take the reader through the steps required to solve a real-world problem. How-to guides are goal-oriented\. How-to guides can be thought of as recipes, directions that guide the reader through the steps to achieve a specific end. Examples could be: how to calibrat... | how-to-guides.txt |
How to use Diátaxis ¶ In short, the answer is: pragmatically\. Diátaxis is based on sound theoretical principles and has been proven in practice, but it’s not the final word in documentation. The only value that it can offer you is to be useful in helping make your documentation better for its users, and easier for you... | how-to-use-diataxis.txt |
The map of needs ¶ How to organise my documentation? In the absence of a clear, generalised documentation architecture, documentation creators will usually try to structure their work around characteristics or features of the product its intended to serve. This is rarely successful, even in a single instance. In a port... | needs.txt |
Towards a theory of quality in documentation ¶ Diátaxis is an approach to quality in documentation. “Quality” is a word in danger of losing some of its meaning; it’s something we all approve of, but rarely risk trying to describe in any rigorous way. We want quality in our documentation, but much less often specify wha... | quality.txt |
Explanation and reference ¶ Explanation and reference both belong to the theory half of the Diátaxis map - they don’t contain steps to guide the reader, they contain theoretical knowledge. The difference between them is - just as in the difference between tutorials and how-to guides - the difference between the acquisi... | reference-explanation.txt |
About reference ¶ Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented\. The only purpose of a reference guide is to describe, as succinctly as possible, and in an orderly way. Whereas the content of tutorials and how-to guides are led by needs o... | reference.txt |
What’s the difference between a tutorial and how-to guide? ¶ In Diátaxis, tutorials and how-to guides are strongly distinguished. It’s a distinction that’s often not made; in fact the single most common conflation made in software product documentation is that between the tutorial and the how-to guide\. So: what is the... | tutorials-how-to.txt |
About tutorials ¶ Tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind. Tutorials are learning-oriented\. A tutorial must help a beginner achieve basic competence with a product, so that they can go on to use the product for their own purposes. A tutorial a... | tutorials.txt |
No dataset card yet
- Downloads last month
- 6