GNOME.org

Who Should Read This Guide

Different parts of this guide are of different levels of interest to writers, depending on your level of experience, as shown in the following table. The key to the table is as follows:

* You are probably familiar with this material. You only need to refer to this material for reference.
** This information is of interest to you, however other parts of the guide are probably of more immediate interest. You can read these sections when you have time.
*** This information is of immediate interest to you.

Section New Writers Experienced Writers
Chapter 1 ― Fundamental Concepts of Technical Documentation *** *
Chapter 2 ― Basic Building Blocks of Information Design *** *
Chapter 3 ― Grammar and Usage Guidelines *** ***
Chapter 4 ― Writing Documentation for an International Audience *** ***
Chapter 5 ― Ways to Improve Your Documentation ** **
Chapter 6 ― Indexing Your Documentation ** **
Chapter 7 ― Writing for GUIs ** ***
Chapter 8 ― Usability and Readability Considerations for Technical Documentation ** **
Chapter 9 ― Writing Accessible Documentation ** ***
Chapter 10 ― Use of Screenshots ** ***
Chapter 11 ― Legal Topics ** **
Appendix A ― Recommended Terminology *** ***
Appendix B ― Units *** ***
Appendix C ― Glossary of Terms in This Guide ** *
Appendix D ― Examples of Information Design Building Blocks *** *
Appendix E ― GDSG Contributors * *
What Is in This Guide Associated Documentation

About