[gnome-devel-docs] hig: elaborate the writing style guidelines a little



commit f0fa1501e87ad9d5975406fd42bb8a0a23d73514
Author: Allan Day <allanpday gmail com>
Date:   Thu Aug 4 14:15:23 2016 +0100

    hig: elaborate the writing style guidelines a little

 hig/C/writing-style.page |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
---
diff --git a/hig/C/writing-style.page b/hig/C/writing-style.page
index f8300be..bb4c9f0 100644
--- a/hig/C/writing-style.page
+++ b/hig/C/writing-style.page
@@ -47,8 +47,11 @@
 <item><p>Keep text short and to the point. This improves speed of comprehension for the user. It also 
reduces the expansion of text when translated (remember that translated English text can expand up to 30% in 
some languages).</p></item>
 <item><p>Do not shorten your text to the point of losing meaning. A three-word label that provides clear 
information is better than a one-word label that is ambiguous or vague. Try to find the fewest possible words 
to satisfactorily convey the meaning of your label.</p></item>
 <item><p>Use words, phrases, and concepts that are familiar to the people who will be using your 
application, rather than terms from the underlying system. This may mean using terms that are associated with 
the tasks your application supports. For example, in medicine, the paper folder that contains patient 
information is called a “chart”. Hence, a medical application might refer to a patient record as a “chart” 
rather than as a “patient database record”.</p></item>
-<item><p>Use the standard GNOME terms when referring to parts of the user interface, such as ‘pointer’ and 
‘window’. The HIG can be used as a reference in this regard.</p></item>
+<item><p>Text should adopt a neutral tone and speak from the point of view of the product. Pronouns like 
“you” or "my” should therefore be avoided wherever possible. However, if they are unavoidable “your” is 
preferable to “my”.</p></item>
+<item><p>Use the standard GNOME terms when referring to parts of the user interface, such as “pointer” and 
“window”. The HIG can be used as a reference in this regard.</p></item>
 <item><p>Avoid repetition where possible.</p></item>
+<item><p>Sentences should not be constructed from text in several controls, and each label should be treated 
as being self-contained. Sentences that run from one control to another will often not make sense when 
translated into other languages.</p></item>
+<item><p>Latin abbreviations such as “ie” or “eg” should be avoided, since they can't always be easily 
translated and can be unintelligable when read by screen readers. Instead, use full words like “for 
example”.</p></item>
 </list>
 
 </section>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]