GNOME.org

What Is in This Guide

This guide contains the following sections:

Section Summary
Chapter 1 ― Fundamental Concepts of Technical Documentation Introduces basic concepts of technical documentation.
Chapter 2 ― Basic Building Blocks of Information Design Describes how to use different types of information structures.
Chapter 3 ― Grammar and Usage Guidelines Provides advice and examples about how to use specific parts of grammar.
Chapter 4 ― Writing Documentation for an International Audience Provides guidelines to cater for the most common problems encountered by translators of technical documentation.
Chapter 5 ― Ways to Improve Your Documentation Outlines some tips about how you can review and improve your writing.
Chapter 6 ― Indexing Your Documentation Describes basic index requirements and indexing techniques.
Chapter 7 ― Writing for GUIs Describes how to write about GNOME user interfaces.
Chapter 8 ― Usability and Readability Considerations for Technical Documentation Discusses readability issues, and gives some ways to assess readability.
Chapter 9 ― Writing Accessible Documentation Discusses the needs of disabled users of technical documentation.
Chapter 10 ― Use of Screenshots Provides style guidelines for screenshots.
Chapter 11 ― Legal Topics Covers essential legal topics in GNOME documentation.
Appendix A ― Recommended Terminology Provides a comprehensive list of agreed terminology for use in GNOME documentation.
Appendix B ― Units Provides a list of standard units that appear in GNOME documentation, or in the GNOME Desktop.
Appendix C ― Glossary of Terms in This Guide Provides a list of unfamiliar language terms that are used in this guide.
Appendix D ― Examples of Information Design Building Blocks Provides examples of the information design building blocks discussed in Chapter 2 ― Basic Building Blocks of Information Design.
Appendix E ― GDSG Contributors Lists contributors to this guide.
About This Guide Who Should Read This Guide

About