From 4920b9b195ea26e6fd12f9ff84dacb7fa01f0a73 Mon Sep 17 00:00:00 2001 From: aba Date: Sat, 16 Jun 2007 19:36:09 +0000 Subject: [PATCH] write documentation details. #422750 git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@4654 313b444b-1b9f-4f58-a734-7bb04f332e8d --- debian/changelog | 4 +++- developers-reference.sgml | 8 ++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/debian/changelog b/debian/changelog index 0bfa587..f23e0d0 100644 --- 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 Sat, 16 Jun 2007 11:41:41 -0600 + -- Andreas Barth 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 a6713b2..ee8366f 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -7,7 +7,7 @@ %dynamicdata; - + @@ -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 ...". Be gender neutral

-- 2.30.2