[documentation-guide: 3/4] Make this sentence easier to read

Jared Smith jsmith at fedoraproject.org
Sun Mar 23 03:07:53 UTC 2014


commit 236d4469a4f3b54827074e3b143362cc17c0c03d
Author: Jared K. Smith <jaredsmith at jaredsmith.net>
Date:   Sat Mar 22 23:07:03 2014 -0400

    Make this sentence easier to read

 en-US/style.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
---
diff --git a/en-US/style.xml b/en-US/style.xml
index 3523b6f..5bd4220 100644
--- a/en-US/style.xml
+++ b/en-US/style.xml
@@ -5,7 +5,7 @@
 ]>
 <chapter id="chap-documentation_guide-style">
 	<title>Style Guide</title>
-	<para>Writing high-quality documents easily understood by multiple readers is a difficult challenge.  There are many different techniques that can be used in writing, and there are many different ways of writing the same information.  In order to provide consistent, readable documentation, certain standards must be established.  There are many different writing style guides that serve different purposes and audiences.  Good style is something learned and practiced.</para>
+	<para>Writing high-quality documents that are easily understood by multiple readers is a difficult challenge.  There are many different techniques that can be used in writing, and there are many different ways of writing the same information.  In order to provide consistent, readable documentation, certain standards must be established.  There are many different writing style guides that serve different purposes and audiences.  Good style is something learned and practiced.</para>
 	<para>The Fedora Documentation Project is tasked with producing friendly, easy-to-read documentation for a worldwide audience.  This means writing clean, clear documents with great attention to differences in cultures and languages.  The Fedora Documentation Style Guide outlines specific rules and recommendations for documentation contributors. The style guidelines standardize documentation of both technical and non-technical information, to increase readability and comprehension.</para>
 	<para>The writers producing Fedora documentation come from a variety of backgrounds, each with different skill sets.  Through use of the Fedora Documentation Style Guide, contributors produce and collaborate on documentation with consistent results.  This style guide may vary from each contributor's familiar writing requirements. Practicing this guide will eventually become a comfortable standard with benefits outside of Fedora documentation.  This style guide will demonstrate the rules and guidelines it sets forth.</para>
 	<para>The Fedora Documentation Style Guide borrows many ideas from the Associated Press (AP) Stylebook and The Chicago Manual of Style. Any differences from those guides are intended to enhance the value of documents for international readers, and accommodate the technical nature of Fedora documentation.  Particular care is made to adopt international standards for common notations to avoid confusion across cultural lines.</para>


More information about the docs-commits mailing list