Skip to content

Commit d9db1c3

Browse files
committed
Authoring guidelines: Mention "Diátaxis" approach
1 parent 2e50351 commit d9db1c3

File tree

2 files changed

+37
-12
lines changed

2 files changed

+37
-12
lines changed

style/general.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,40 @@
22
General 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+
539
Consistency makes collaboration easier. To that end, please try to follow the
640
applicable general conventions.
741

@@ -14,3 +48,6 @@ We have two core principles:
1448

1549
2. Know when to be inconsistent. Break any of these conventions sooner than
1650
doing anything foolish.
51+
52+
53+
.. _Diátaxis: https://diataxis.fr/

style/repos.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -160,17 +160,5 @@ The ``docs`` directory is reserved for use as a Sphinx_ documentation project.
160160
All 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/

0 commit comments

Comments
 (0)