Archive:Docs Project Style Guide

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m
Line 31: Line 31:
 
# [[Docs Project Style Guide - Fedora Specific|Fedora-Specific Conventions]]  
 
# [[Docs Project Style Guide - Fedora Specific|Fedora-Specific Conventions]]  
 
# [[Docs Project Style Guide - Common Mistakes|Common Mistakes]]  
 
# [[Docs Project Style Guide - Common Mistakes|Common Mistakes]]  
# [[Docs Project Style Guide - Word usage, capitalization, and spelling]]
+
# [[Docs Project Style Guide - Word usage, capitalization, and spelling|Word Usage, Capitalization, and Spelling]]
 
# [[Docs Project Style Guide - Quick Reference|Quick Reference]]  
 
# [[Docs Project Style Guide - Quick Reference|Quick Reference]]  
 
# [[Docs Project Style Guide - Resources|Resources]]
 
# [[Docs Project Style Guide - Resources|Resources]]

Revision as of 19:49, 22 August 2012

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. Word Usage, Capitalization, and Spelling
  8. Quick Reference
  9. Resources