Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.25 KB

theory.rst

File metadata and controls

35 lines (21 loc) · 1.25 KB

Understanding Diátaxis

The Grand Unified Theory of Documentation

-- David Laing


The pages in this section are intended to provide some theoretical grounding for the practices Diátaxis prescribes, and to explore some of the questions it raises.

Within the discipline of documentation, discourse tends towards the practical and concrete. The approach is generally heuristic: guidelines, rules of thumb, specific imperatives, principles that we know work.

As practitioners, we have much to say about what to do, and how to do it and how it works, and relatively little to say about why it works. Our sense of the right way to do things is largely based on a combination of intuition and experience. The theoretical aspect of the discipline receives far less attention.

Diátaxis aims to place documentation practice on a more rigorous theoretical footing.


In this section

These pages dig deeper into the thinking that underpins Diátaxis.

  • foundations - why Diátaxis works
  • map - documentation in two dimensions
  • quality

Common problems explored:

  • tutorials-how-to
  • reference-explanation
  • complex-hierarchies