From Fedora Project Wiki

m (DocsProject/StyleGuide moved to Docs Project Style Guide over redirect: wiki cleanup)
m (fixing links)
Line 22: Line 22:
 
The Fedora Documentation Project produces documentation of the highest possible quality.  To attain this goal, FDP documents must follow a consistent, readable style.  The Fedora Documentation Style Guide provides uniform guidelines for specific elements of Fedora Documentation.  The Fedora Project uses American English (en_US) as its language of business, and recommends dictionaries published by Merriam-Webster for spelling reference.
 
The Fedora Documentation Project produces documentation of the highest possible quality.  To attain this goal, FDP documents must follow a consistent, readable style.  The Fedora Documentation Style Guide provides uniform guidelines for specific elements of Fedora Documentation.  The Fedora Project uses American English (en_US) as its language of business, and recommends dictionaries published by Merriam-Webster for spelling reference.
  
[[/FullGuide|  View the Full Guide]]
 
  
 
'''Table of Contents'''
 
'''Table of Contents'''
  
# [[/IntroductionToStyle|Introduction to Style]]  
+
# [[Docs Project Style Guide - Introduction to Style|Introduction to Style]]  
# [[/GeneralGuidelines|General Guidelines]]  
+
# [[Docs Project Style Guide - General Guidelines|General Guidelines]]  
# [[/ContentAndRendering|Content and Rendering]]  
+
# [[Docs Project Style Guide - Content and Rendering|Content and Rendering]]  
# [[/DatesAndTimes|Dates and Times]]  
+
# [[Docs Project Style Guide - Dates and Times|Dates and Times]]  
# [[/FedoraSpecific|Fedora-Specific Conventions]]  
+
# [[Docs Project Style Guide - Fedora Specific|Fedora-Specific Conventions]]  
# [[/CommonMistakes|Common Mistakes]]  
+
# [[Docs Project Style Guide - Common Mistakes|Common Mistakes]]  
# [[/QuickReference|Quick Reference]]  
+
# [[Docs Project Style Guide - Quick Reference|Quick Reference]]  
# [[/Resources|Resources]]
+
# [[Docs Project Style Guide - Resources|Resources]]
  
 
[[Category:Docs Project process]]
 
[[Category:Docs Project process]]
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Revision as of 03:14, 26 February 2009

DocsProject Header docTeam1.png


Fedora Documentation Style Guide

Documentation Summary:

Purpose: Defining specific style guidelines for use in Fedora Documentation

Audience: Fedora Documentation and Fedora Website writers and editors

Assumptions: The reader must be familiar with the English language, including the basic language syntax.

Related Documents: The Documentation Guide outlines the standard practices of the Fedora Documentation Project.

Lead Writer: PatrickBarnes


The Fedora Documentation Project produces documentation of the highest possible quality. To attain this goal, FDP documents must follow a consistent, readable style. The Fedora Documentation Style Guide provides uniform guidelines for specific elements of Fedora Documentation. The Fedora Project uses American English (en_US) as its language of business, and recommends dictionaries published by Merriam-Webster for spelling reference.


Table of Contents

  1. Introduction to Style
  2. General Guidelines
  3. Content and Rendering
  4. Dates and Times
  5. Fedora-Specific Conventions
  6. Common Mistakes
  7. Quick Reference
  8. Resources