A systematic framework for technical documentation authoring.

This is a very short post. I’m just posting a link to Diátaxis to raise awareness of the framework. Diátaxis is a framework that explains what kinds of documentation a project needs and more importantly what purpose it should fulfill. A tutorial satisfies a different use-case as a technical documentation of your API for example. You can find further information here as well.

Why am I doing this? Well, because first I really like the framework and I think it completes what I wrote recently about my documentation attempts with sphinx. Secondly, writing a short blog post is an easy way for me not to forget where the description of the framework is located (browser bookmarks don’t work for me).


Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License

Mathematician and
Software Engineer

Researcher, Engineer, Tinkerer, Scholar, Philosopher, and Hyrox afficionado