write documentation details. #422750

git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@4654 313b444b-1b9f-4f58-a734-7bb04f332e8d

diff --git a/debian/changelog b/debian/changelog
index 0bfa587bf01e84d1d9c5647ed7f4aeed16640524..f23e0d01958323b304ee82f917dc9e8ae80bd732 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,8 +13,10 @@ developers-reference (3.3.9) unstable; urgency=low
   * NMUs now also close bugs. Thanks, Lucas Nussbaum. Closes: #419507
   * Fix documentation about gender neutral. Closes: #384178
   * Fix typo. Closes: #405453
+  * More details on how to write documentation. Thanks, Josh Triplett.
+    Closes: #422750
 
- -- Andreas Barth <aba@gluck.debian.org>  Sat, 16 Jun 2007 11:41:41 -0600
+ -- Andreas Barth <aba@not.so.argh.org>  Sat, 16 Jun 2007 11:41:41 -0600
 
 developers-reference (3.3.8) unstable; urgency=low
 

diff --git a/developers-reference.sgml b/developers-reference.sgml
index a6713b2451e7ad133223cf3fb21f666934d2de53..ee8366f94e4ea104353d703a3bae9521ef0acef3 100644 (file)
--- a/developers-reference.sgml
+++ b/developers-reference.sgml
@@ -7,7 +7,7 @@
   <!ENTITY % dynamicdata  SYSTEM "dynamic.ent" > %dynamicdata;
 
   <!-- CVS revision of this document -->
-  <!ENTITY cvs-rev "$Revision: 1.322 $">
+  <!ENTITY cvs-rev "$Revision: 1.323 $">
 
   <!-- if you are translating this document, please notate the CVS
        revision of the original developer's reference in cvs-en-rev -->
@@ -4316,9 +4316,13 @@ Just give facts.
 You should avoid the use of first person ("I will do this..." or "We
 recommend..."). The computer is not a person and the Debconf templates
 do not speak for the Debian developers. You should use neutral
-construction and often the passive form. Those of you who already
+construction. Those of you who already
 wrote scientific publications, just write your templates like you
 would write a scientific paper.
+However, try using action voice if still possible, like
+"Enable this if ..."
+instead of
+"This can be enabled if ...".
 
        <sect2>Be gender neutral
        <p>