Write effective Documentation with Diátaxis
Page Status: Draft (What's this?)
Introduction¶
One day, I was browsing HackerNews, when I stumbled upon a thread about Diátaxis.
Core Concepts¶
In Diátaxis, documentation pages can be organized into four categories:
- Tutorials,
- How-To Guides,
- Explanation, and
- Reference.
These four categories are explained in the quick start guide. Reading through their documentation is definitely worth the 30-60 minutes.
While I was writing documentation in my previous years, I was just winging the pages without much thought. However, after reading the Diátaxis framework and knowing about the categories, it was suddenly much clearer what I'm currently writing and what to look out for.
Applying it to your own documentation¶
(todo)