GNOME Logo

GNOME Handbook of Writing Software Documentation V1.0.2

About This Document

Table of Contents

1. Introduction
1.1. GNOME Documentation Project
1.2. Notation and Conventions
1.3. About this Handbook
2. GNOME Documentation System
2.1. DocBook
2.2. GNOME Help Browser
2.3. Scrollkeeper
2.4. GNOME Documentation Components
2.5. Using CVS
3. Getting Started Writing GNOME Documentation
3.1. Selecting A Document
3.2. Installing DocBook
3.3. Using DocBook Tools
3.4. GDP Document Templates
3.5. Converting GNOME 1.x Documentation to GNOME 2
3.6. GDP Style Guide
3.7. Screenshots
3.8. Application Bugs
4. DocBook Basics
4.1. Introduction to DocBook
4.2. Structure Elements
4.3. Inline Elements
4.4. Indexing
5. GDP Documentation Conventions
5.1. Conventions for all GDP Documentation
5.2. Conventions for Application Documentation
6. Writing Application and Applet Manuals
7. Cross Referencing Other Documentation
7.1. GNOME Documentation
7.2. Man and Info Pages
8. Writing Context Sensitive Help (coming in GNOME-3.0)
9. Building Documentation within a Program
9.1. Documentation Files
9.2. Adding Documentation to the Build Setup
9.3. Listing Documents in the Help Menu
9.4. Adding Help Buttons
10. Teamwork
10.1. Working with the GDP Team
10.2. Working with Developers
11. Finishing a Document
11.1. Editing the Document
11.2. Submitting the Document
11.3. Maintaining the Document
A. Resources