Archive:Docs Project Style Guide

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (Sparks moved page Docs Project Style Guide to Archive:Docs Project Style Guide: Moved to guide)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Moved to guide}}
 
{{header|docs}}
 
{{header|docs}}
  
Line 8: Line 9:
 
'''Documentation Summary:'''
 
'''Documentation Summary:'''
  
'''Purpose:''' Defining specific style guidelines for use in Fedora Documentation
+
'''Purpose:''' Define specific style guidelines for Fedora Documentation
  
'''Audience:''' Fedora Documentation and Fedora Website writers and editors
+
'''Audience:''' Members of Fedora Documentation Project and Fedora Websites Project
  
'''Assumptions:''' The reader must be familiar with the English language, including the basic language syntax.
+
'''Assumptions:''' You should be familiar with the English language, including the basic language syntax.
  
'''Related Documents:''' The [http://docs.fedoraproject.org/documentation-guide Documentation Guide] outlines the standard practices of the Fedora Documentation Project.
+
'''Related Documents:''' The [http://docs.fedoraproject.org/documentation-guide Documentation Guide] outlines standard practices of the Fedora Documentation Project.
  
 
'''Lead Writer:''' PatrickBarnes
 
'''Lead Writer:''' PatrickBarnes
Line 20: Line 21:
 
----
 
----
  
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, Documentation Project documents 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) primarily. We recommend dictionaries published by Merriam-Webster for spelling reference.
 
+
  
 
'''Table of Contents'''
 
'''Table of Contents'''

Latest revision as of 14:48, 22 March 2014

Important.png
Old page
The data in this page has been incorporated into a formal guide and is no longer being maintained.
DocsProject Header docTeam1.png


[edit] Fedora Documentation Style Guide

Documentation Summary:

Purpose: Define specific style guidelines for Fedora Documentation

Audience: Members of Fedora Documentation Project and Fedora Websites Project

Assumptions: You should be familiar with the English language, including the basic language syntax.

Related Documents: The Documentation Guide outlines 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, Documentation Project documents 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) primarily. We recommend 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. Word Usage, Capitalization, and Spelling
  8. Quick Reference
  9. Resources