1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
.. _documentation-practices:
=======================
Documentation practices
=======================
The documentation is written following the `Diátaxis <https://diataxis.fr/>`_
principles.
Voice of the documentation
--------------------------
Tutorials and How-to guides refer to the user as "you": the documentation
tell the user how to do something on their own. For example `"You can use
Debian trixie to install..."`.
For explanations and reference use impersonal and passive forms. For example
`"Debian trixie can be used..."`, "Execution of the command results in..."`,
`"The command outputs..."` or `"Output is produced by the command"`.
|
