TL;DR:
- Diátaxis - это метод для создания документации
- Документация строиться итеративно, но всегда полноценно
- Метод предлагает разбить документацию на 4 варианта ниже
| Tutorials | How-to guides | Reference | Explanation | |
|---|---|---|---|---|
| what they do | introduce, educate, lead | guide | state, describe, inform | explain, clarify, discuss |
| answers the question | “Can you teach me to…?” | “How do I…?” | “What is…?” | “Why…?” |
| oriented to | learning | goals | information | understanding |
| purpose | to provide a learning experience | to help achieve a particular goal | to describe the machinery | to illuminate a topic |
| form | a lesson | a series of steps | dry description | discursive explanation |
| analogy | teaching a child how to cook | a recipe in a cookery book | information on the back of a food packet | an article on culinary social history |