[documentation-guide] Added style guide

Eric Christensen sparks at fedoraproject.org
Sat Mar 22 13:55:31 UTC 2014


commit 8a153f61d429beec87d8ac0e2ffde75b0046de97
Author: Eric Christensen <echriste at redhat.com>
Date:   Sat Mar 22 09:55:25 2014 -0400

    Added style guide

 en-US/style.xml |   57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 57 insertions(+), 0 deletions(-)
---
diff --git a/en-US/style.xml b/en-US/style.xml
index d203208..5ada235 100644
--- a/en-US/style.xml
+++ b/en-US/style.xml
@@ -1046,6 +1046,7 @@ Avoid using this term.
 					<member>twenty-five thousand one hundred thirty-one</member>
 					<member>ninety bottles</member>
 				</simplelist>
+				</para>
 			</section>
 
 <!--
@@ -1225,4 +1226,60 @@ In addition, all documentation should contain the disclaimer:  "All other tradem
 -->
 		</section>
 	</section>
+	<section id="sect-documentation_guide-style-resources">
+		<title>Resources</title>
+		<para/>
+		<section id="sect-documentation_guide-style-resources-FLOSS">
+			<title>Useful FLOSS Project Guides</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://library.gnome.org/devel/gdp-style-guide/stable/">GNOME Documentation Style Guide</ulink></member>
+			</simplelist>
+			</para>
+		</section>
+		<section id="sect-documentation_guide-style-resources-other_style_guides">
+			<title>Other Style Guides</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://www.ap.org">The Associated Press</ulink></member>
+				<member><ulink url="http://www.chicagomanualofstyle.org">The Chicago Manual of Style</ulink></member>
+				<member><ulink url="http://en.wikipedia.org/wiki/Style_guide">Wikipedia article on style guides</ulink></member>
+			</simplelist>
+			</para>
+		</section>
+		<section id="sect-documentation_guide-style-resources-grammar">
+			<title>US-English Grammar</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://www.grammarbook.com/grammar/subjectVerb.asp">The Blue Book of Grammar and Punctuation</ulink> provides examples of common difficulties encountered when writing in English.  The Table of Contents covers "Who and Whom", "Who vs. Which vs. That" to "Effective Writing".  Provides useful and clear examples with memorable tools.</member>
+			</simplelist>
+			</para>
+		</section>
+		<section id="sect-documentation_guide-style-resources-standards">
+			<title>Standards</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://en.wikipedia.org/wiki/ISO_8601">Wikipedia article on ISO-8601</ulink>, "Data elements and interchange formats -- Information interchange -- Representation of dates and times"</member>
+				<member><ulink url="http://en.wikipedia.org/wiki/UTC">Wikipedia article on Coordinated Universal Time</ulink></member>
+				<member><ulink url="Wikipedia article on Coordinated Universal Time">Wikipedia article on binary prefixes</ulink></member>
+			</simplelist>
+			</para>
+		</section>
+		<section id="sect-documentation_guide-style-resources-DocBook">
+			<title>DocBook</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://www.docbook.org">Documentation for DocBook</ulink></member>
+			</simplelist>
+			</para>
+		</section>
+		<section id="sect-documentation_guide-style-resources-other">
+			<title>Other Resources</title>
+			<para>
+			<simplelist>
+				<member><ulink url="http://www.m-w.com">Merriam-Webster Online</ulink></member>
+			</simplelist>
+			</para>
+		</section>
+	</section>
 </chapter>


More information about the docs-commits mailing list