✳flâneur — a map of the web's best reading

How to use Diátaxis - Diátaxis

diataxis.fr · 1,178 words · saved by 1 readers

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 to create and maintain. The best thing you can do with it therefore is take from it however much seems to work for you: as much or as little as you wish. Diátaxis describes a complete picture of documentation. However the structure it proposes is not intended to be a plan, something you must complete in your documentation. It’s a guide, a map to help you check that you’re in the right place and going in the right directions. The point of Diátaxis is to give you a way to think about and understand your documentation, so that you can make better sense of what it’s doing and what you’re trying to do with it. It provides tools that help assess it, identify where its problems lie, and judge what you can do to improve it. Although structu

Diátaxis as a guide to work ¶ As well as providing a guide to documentation content, Diátaxis is also a guide to documentation process and execution. Most people who work on technical documentation must make decisions about how to work, as they work. In some contexts, documentation must be delivered once, complete and in its final state, but it’s more usual that it’s an on-going project, for example developed alongside a product that itself evolves and develops. It’s also the experience of many people who work on documentation to find themselves responsible for improving or even remediating a

Explore this link on the map →

related reading