File tree Expand file tree Collapse file tree 2 files changed +27
-12
lines changed
Expand file tree Collapse file tree 2 files changed +27
-12
lines changed Original file line number Diff line number Diff line change 22General Conventions
33===================
44
5+ Approach
6+ ========
7+
8+ `Diátaxis `_ is a systematic approach to technical documentation authoring.
9+
10+ Loosely 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+ Consistency
27+ ===========
28+
529Consistency makes collaboration easier. To that end, please try to follow the
630applicable general conventions.
731
@@ -14,3 +38,6 @@ We have two core principles:
1438
15392. Know when to be inconsistent. Break any of these conventions sooner than
1640 doing anything foolish.
41+
42+
43+ .. _Diátaxis : https://diataxis.fr/
Original file line number Diff line number Diff line change @@ -160,17 +160,5 @@ The ``docs`` directory is reserved for use as a Sphinx_ documentation project.
160160All Sphinx projects must use a top-level directory named ``docs ``.
161161
162162
163- Repo structure
164- ==============
165-
166- There are three main types of documentation: tutorials, howtos, and reference.
167-
168- Tutorials are for step-by-step guides that guide you from beginning to end through a process (e.g., installation or cluster deployment).
169-
170- Howtos are for guides to performing a single particular operation (e.g., deleting a cluster).
171-
172- Reference is for reference information (e.g., a list of SQL syntax or an overview of the CrateDB Cloud Console).
173-
174-
175163.. _reStructuredText : http://docutils.sourceforge.net/rst.html
176164.. _Sphinx : http://sphinx-doc.org/
You can’t perform that action at this time.
0 commit comments