From 41145e543a32161a85d73cf407b18efe70d0788b Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=B6rn=20Nettingsmeier?= Date: Wed, 5 Feb 2014 18:31:32 +0100 Subject: [PATCH] style guide update. --- STYLE_GUIDE | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/STYLE_GUIDE b/STYLE_GUIDE index 7d2dad4..001b2a7 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -278,3 +278,19 @@ If you encounter something that is unclear or patent nonsense, but you are not bold or knowledgeable to fix it, express your doubts with an

editorial note

, so that readers will be warned and fellow editors know where there's work to do. + +5.5 Writing style suggestions +----------------------------- + +* "Click OK" and similar explanations of the utterly obvious should be +avoided. Keep the writing concise and to the point. Explain as much as +possible, with as few words as possible. +* Do not fear repetitions, this is not artistic prose. Repeat important +keywords, rather than burden the user with synonyms made up on the spot. +* Do not create headings for different ways of doing the same thing (Via +the context menu,...Via hotkeys). Headings separate new +concepts. To not add gratuitous sub-headings if there is very little +content per heading and you do not expect the article to grow. +* If pages grow long, consider splitting them into sub-chapters at their +headings. +* Nobody needs "the next paragraph is about the following" paragraphs. -- 2.37.2