diff options
author | ng0 <ng0@n0.is> | 2018-01-04 16:33:50 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2018-01-04 16:33:50 +0000 |
commit | e9c8850dd6324241c4e1567289b617be44bda1d3 (patch) | |
tree | 5e4421f4cdd553fd6b8220fef77eb3ce3b3c67d8 /doc/documentation | |
parent | 2560f7683d7184dc6cdcc3324014663d047c3447 (diff) |
doc/documentation/README.txt: remove obsolete lines
Diffstat (limited to 'doc/documentation')
-rw-r--r-- | doc/documentation/README.txt | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt index e3eb6c8acf..9e76394c3f 100644 --- a/doc/documentation/README.txt +++ b/doc/documentation/README.txt @@ -1,44 +1,3 @@ -To be moved to an appropriate section of "how to write documentation" or -"how to contribute to the documentation": - -1. When writing documentation, please use gender-neutral wording when - referring to people, such as singular “they”, “their”, “them”, and - so forth. -> https://en.wikipedia.org/wiki/Singular_they - -2. Keep line length below 74 characters. - - Expection by texi2pdf output so far: URLs will break - (inserted whitespace) when they contain linebreaks - within the @url{} / @uref{}. - -3. Do not use tab characters (see chapter 2.1 texinfo manual) - -4. Use neutral language and third person perspective in the text - -4.1 So, when you refer to a user in general or addressing the user, - refer to (1). -4.1.1 Unsolved exceptions for canonical reasons: - When refering to Alice, use "she". - When refering to Bob, use "he". - These are long established examples and they - should either be replaced (avoid Alice and Bob - examples when you can) or followed. - -5. Use 2 spaces between sentences, so instead of: - - We do this and the other thing. This is done by foo. - - Write: - - We do this and the other thing. This is done by foo. - -6. Use @footnote{} instead of putting an @*ref{} to the footnote on a - collected footnote-page. - In a 200+ pages handbook it's better to have footnotes accessible - without having to skip over to the end. - -6.1 Avoid unnecessary footnotes, keep the text self-explanatory and - in a simple language where possible/necessary. - * Completion Levels: ** chapters/philosophy: around 100% fixed after initial export. |