Product SiteDocumentation Site

Open-Source Style Guide

Manual for Technical Writers

Documenting software projects and products

Edition 0

Red Hat Engineering Content Services

Edited by

Rüdiger Landmann

Red Hat Engineering Content Services

Legal Notice

Copyright © 2010 Red Hat, Inc. and others
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution 3.0 Unported license ("CC-BY"). An explanation of CC-BY is available at In accordance with CC-BY, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.

1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. We Need Feedback!
1. Word Usage
2. Punctuation
2.1. Colons and semicolons
2.1.1. To relate clauses
2.1.2. To introduce a series or list
2.2. Commas
2.2.1. In compound sentences
2.2.2. In adverbial clauses and phrases
2.2.3. In adjectival clauses and phrases
2.2.4. With coordinate adjectives
2.2.5. With series and lists
2.3. Parentheses
2.4. Quotation Marks
2.5. Apostrophes
3. Grammar
3.1. Active Voice
3.2. Agreement
3.2.1. Pronoun-Antecedent Agreement
3.3. Sentence Structure
3.3.1. Sentence Fragments
3.3.2. Run on sentences
3.4. Contractions
3.5. Gender References
3.6. Tense
4. Design
4.1. Heading Styles
4.2. Screenshots
4.3. Diagrams
4.4. Example Domain References
4.5. Example Computer Output
4.6. Admonitions
4.7. Additional Resources
4.8. Book References
5. Avoiding Slang
6. Cross References
7. Standard Terminology
8. XML Tags
9. Resources
A. Revision History