[documentation-guide] starting some basic structure in the style chapter, will pull from wiki\ at http://fedoraproject.org
Pete Travis
immanetize at fedoraproject.org
Tue Oct 25 15:50:46 UTC 2011
commit 36848ede9f9719223c95a76780fdd89721e84040
Author: Pete Travis <pete at thefool.petetravis.com>
Date: Mon Oct 24 22:36:52 2011 -0600
starting some basic structure in the style chapter, will pull from wiki\
at http://fedoraproject.org/wiki/DocsProject/DocumentationGuide/StyleToDo
en-US/docbook.xml | 2 +-
en-US/style.xml | 22 +++++++++++++++++++---
2 files changed, 20 insertions(+), 4 deletions(-)
---
diff --git a/en-US/docbook.xml b/en-US/docbook.xml
index d3a701f..0515f11 100644
--- a/en-US/docbook.xml
+++ b/en-US/docbook.xml
@@ -10,7 +10,7 @@
</para>
<section>
<title>Why DocBook?</title>
- <para/>
+ <para />
</section>
<section>
<title>DocBook as an XML Markup Language</title>
diff --git a/en-US/style.xml b/en-US/style.xml
index 48c0540..866fb13 100644
--- a/en-US/style.xml
+++ b/en-US/style.xml
@@ -6,7 +6,23 @@
<chapter id="chap-documentation_guide-style">
<title>Style Guide</title>
<para>
- This is the Fedora Documentation style guide.
+ Your writing should be styled consistently and concisely. This section will outline style conventions to be used when writing documentation.
</para>
-</chapter>
-
+
+ <section id="sect-documentation_guide-style-be_Consistent">
+ <title>Be Consistent</title>
+ <para>
+ Make the flow of information easy to follow from point to point. If you need to sidetrack, link.
+ </para>
+ <section id="sect-documentation_guide-style-be_direct">
+ <title>Be Direct</title>
+ <para>
+ Get straight to the point.
+ </para>
+ <section id="sect-documentation_guide-style-be_concise">
+ <title>Be Concise</title>
+ <para>
+ Don't use bromides and frivolous clauses.
+ </para>
+ </section>
+</chapter>
\ No newline at end of file
More information about the docs-commits
mailing list