[gnome-devel-docs] HIG: remove broken link to the old documentation style guide
- From: Allan Day <allanday src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-devel-docs] HIG: remove broken link to the old documentation style guide
- Date: Tue, 28 Jul 2015 13:56:19 +0000 (UTC)
commit cc6603ca5dc1dd57f7f367fd1f164b6be83a102f
Author: Allan Day <allanpday gmail com>
Date: Tue Jul 28 14:54:54 2015 +0100
HIG: remove broken link to the old documentation style guide
The link text must have been copied over from the last HIG. Since
the style guide is outdated and unmaintained, so remove the
reference entirely.
hig/C/writing-style.page | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
---
diff --git a/hig/C/writing-style.page b/hig/C/writing-style.page
index 27d0c72..f8300be 100644
--- a/hig/C/writing-style.page
+++ b/hig/C/writing-style.page
@@ -47,7 +47,7 @@
<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’. You can find a full list of these in the GNOME Documentation Style Guide, Recommended
Terminology.</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>
</list>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]