Home
News
Projects
Art
Support
Development
Community
GNOME Documentation Library
Home
Users
Administrators
Developers
About
About This Document
GNOME-STYLE
Preface
Fundamental Concepts of Technical Documentation
General Style Requirements
Golden Rules
Tone
Reaching the Right Audience
Structure
Basic Building Blocks of Information Design
Grammar and Usage Guidelines
Writing Documentation for an International Audience
Ways to Improve Your Documentation
Indexing Your Documentation
Writing for GUIs
Usability and Readability Considerations for Technical Documentation
Writing Accessible Documentation
Use of Screenshots
Legal Topics
Recommended Terminology
Units
Glossary of Terms in This Guide
Examples of Information Design Building Blocks
GDSG Contributors
Fundamental Concepts of Technical Documentation
GNOME-STYLE
This chapter provides a brief introduction to writing technical documentation.
1.1.
General Style Requirements
1.2.
Golden Rules
1.3.
Tone
1.4.
Reaching the Right Audience
1.5.
Structure
Reference Sources
General Style Requirements