GNOME Documentation Style Guide V1.6

Go to page content
Go to main menu
Go to the search field

Preface
- 1. About This Guide
- 2. What Is in This Guide
- 3. Who Should Read This Guide
- 4. Associated Documentation
- 5. Related Documentation
- 6. Reference Sources
1. Fundamental Concepts of Technical Documentation
- 1.1. General Style Requirements
- 1.2. Golden Rules
- 1.3. Tone
- 1.4. Reaching the Right Audience
- 1.5. Structure
2. Basic Building Blocks of Information Design
- 2.1. Section Headings
- 2.2. Jump Lists
- 2.3. Tables
- 2.4. Graphics
- 2.5. Lists
- 2.6. Cross-References
- 2.7. Tips, Notes, and Cautions
- 2.8. Endnotes and Footnotes
3. Grammar and Usage Guidelines
4. Writing Documentation for an International Audience
- 4.1. Goals of the Writer
- 4.2. Cultural Differences
- 4.3. How to Write for Translation
- 4.4. Terminology Considerations for Translation
5. Ways to Improve Your Documentation
- 5.1. Reviews
- 5.2. Checks You Can Do Yourself
6. Indexing Your Documentation
- 6.1. Index Essentials
- 6.2. How to Evaluate Your Index
- 6.3. When to Index GNOME Documentation
7. Writing for GUIs
- 7.1. GUI Basics
- 7.2. Writing About GNOME Desktop GUIs
- 7.3. GNOME Desktop Terminology
- 7.4. Panel Terminology
- 7.5. Menu Terminology
- 7.6. Window Terminology
- 7.7. Dialog Terminology
- 7.8. Button Terminology
8. Usability and Readability Considerations for Technical Documentation
- 8.1. Usability Objectives
- 8.2. Things You Are Not Trying to Do
- 8.3. Strategies for Usability
- 8.4. Readability Tests
9. Writing Accessible Documentation
- 9.1. Assistive Technologies
- 9.2. Information Design Considerations
- 9.3. Accessible Writing Techniques
- 9.4. Text Equivalents for Graphics
- 9.5. More Information About Accessibility
10. Use of Screenshots
- 10.1. Default Settings
- 10.2. Required Formats
- 10.3. Image Width
- 10.4. Special Graphic Effects
- 10.5. Using Callouts
- 10.6. Text Equivalents for Screenshots
- 10.7. When to Use Screenshots
11. Legal Topics
- 11.1. Trademarks
- 11.2. Copyrights
- 11.3. Applying the GFDL
- 11.4. History
- 11.5. Acknowledgements
A. Recommended Terminology
- A.1. Introduction
- A.2. GNOME Desktop Terms
- A.3. Buttons in the GNOME Desktop
- A.4. User Actions
- A.5. General Computer Terms
B. Units
- B.1. Multipliers
- B.2. Unit Abbreviations
C. Glossary of Terms in This Guide
D. Examples of Information Design Building Blocks
- D.1. Level-One Headings
- D.2. Tables
E. GDSG Contributors