22General Conventions
33===================
44
5+ Approach
6+ ========
7+
8+ `Diátaxis `_ is a systematic approach to technical documentation authoring.
9+
10+ Following its paradigms,
11+ there are four main types of documentation:
12+ tutorials, how-to guides, technical reference, and explanation.
13+
14+ - A tutorial is a practical activity, in which the student learns by doing
15+ something meaningful, towards some achievable goal.
16+
17+ - A how-to guide helps the user get something done, correctly and safely;
18+ it guides the user’s action.
19+
20+ - Reference material contains propositional or theoretical knowledge that
21+ a user looks to in their work.
22+
23+ - Explanations deepen and broaden the reader’s understanding of a subject.
24+ They bring clarity, light and context.
25+
26+ .. note ::
27+
28+ **CrateDB documentation loosely follows Diátaxis paradigms. ** There is no
29+ need to adhere to them too strictly across the board when it is not
30+ applicable, or would need too many efforts to refactor or improve
31+ existing material.
32+
33+ It is always good to persue noble goals, but the focus should be on
34+ working software.
35+
36+ Consistency
37+ ===========
38+
539Consistency makes collaboration easier. To that end, please try to follow the
640applicable general conventions.
741
@@ -14,3 +48,6 @@ We have two core principles:
1448
15492. Know when to be inconsistent. Break any of these conventions sooner than
1650 doing anything foolish.
51+
52+
53+ .. _Diátaxis : https://diataxis.fr/
0 commit comments