GDP Documentation Conventions
Prev |  | Next

## GDP Documentation Conventions

### Conventions for All GDP Documentation

#### XML compatibility

All GNOME documentation should conform to XML syntax requirements, which are stricter than SGML ones -- see the section called “XML and SGML” for more informaion.

#### Authors' names

All GNOME documentation should contain the names of both the application authors and documentation authors, as well as a link to the application web page (if it exists) and information for bug submission -- see templates for an example.

### Conventions for Application Documentation

#### Application Version Identification

Application documentation should identify the version of the application for which the documentation is written:

    <sect1 id="intro">
     <title>Introduction</title>
     <para>
      blah-blah-blah This document describes version 1.0.53 of gfoo.
     </para>
    </sect1>

#### Copyright information

Application documentation should contain a copyright notice, stating the licensing terms. It is suggested that you use the GNU Free Documentation License. You could also use some other license allowing free redistribution, such as GPL or Open Content license. If documentation uses some trademarks (such as UNIX, Linux, Windows, etc.), proper legal junk should also be included (see templates).

#### Software license

All GNOME applications must contain information about the license (for software, not for documentation), either in the "About" box or in the manual.

#### Bug reporting

Application documentation should give an address for reporting bugs and for submitting comments about the documentaion (see templates for an example).

Prev | Up | Next
DocBook Basics | Home | Writing Application and Applet Manuals