[documentation-guide] added copy to sect-documentation_guide-style-be_direct

Pete Travis immanetize at fedoraproject.org
Tue Oct 25 15:50:56 UTC 2011


commit b39bf8364a6c6c6d82348d998127ae04ad43859c
Author: Pete Travis <me at petetravis.com>
Date:   Mon Oct 24 23:24:06 2011 -0600

    added copy to sect-documentation_guide-style-be_direct

 en-US/style.xml |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
---
diff --git a/en-US/style.xml b/en-US/style.xml
index c567762..587b121 100644
--- a/en-US/style.xml
+++ b/en-US/style.xml
@@ -17,7 +17,10 @@
 	<section id="sect-documentation_guide-style-be_direct">
 		<title>Be Direct</title>
 		<para>
-			Get straight to the point.
+			Get straight to the point. Embellishments used in spoken language does not add value to a technical document.
+			Be sparing with qualifiers like "usually," "should," and "often." 
+			The progression of the document will be apparent, avoid narrative language such as 
+			"now that we have configured with the file, we are going to issue a command." 
 		</para>
 	</section>	
 	<section id="sect-documentation_guide-style-be_concise">		


More information about the docs-commits mailing list