NixOS/nix.dev
NixOS/nix.dev
1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Code Activity

expand on which voice to use when

Browse source
This commit is contained in:
Valentin Gagarin 2024-08-26 16:28:18 +02:00
parent 50bfb75f17
commit 6b51983ba6
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
source/contributing/documentation/style-guide.md
View file

@ -61,7 +61,13 @@ Describe the subject factually and use the imperative voice in direct instructio
Do not assume a personal relationship with readers, prefer clarity and brevity to emotional appeal.
Use second person ("you") to refer to the reader and only use "we" to refer to the Nix Community.
Use "you" to refer to the reader and only use "we" to refer to the authors.
Both should be rarely needed.
For example:
> You will have to deploy secrets to the remote machine.
> We chose to show the explicit, manual process using `scp` here, but there are various tools to automate that.
### Be correct, cite sources