This is the core document for learning how to write GNOME documentation. It starts with how to get your system set up to work with DocBook. It then discusses using CVS, the GNOME Help System, how to select what to document, the DocTable, documentation templates, GDP documentation standards, what to do when you are done writing a document, and everything else you ever wanted to know about the GDP.
Use this interactive web page to find out which applications need documentation work and to indicate which documents you are working on. You may also use this to discuss and provide suggestions on existing documents. It's also a good idea to check on gnome-doc-list before starting work.
The primary style guide for writing GNOME user documentation. Many parts of it are also applicable to GNOME developer documentation. It includes general information about documentation goals and usability, discussion of audience and tone, information on how to write translatable and clear documents, and a detailed word list so that authors can use consistent terminology.
Templates for applet and application documents. Everyone should use these. They will make documentation easier and faster. It will also make GDP documentation more uniform and consistent. But remember, templates are guidelines and not straightjackets.
Various free licenses in many formats.
In order to create PostScript output (using db2ps or xmlto), you must first convert your screenshots from PNG to EPS by hand.
The GNOME Bug Tracking System: In the process of learning and documenting applications, GDP members tend to push applications beyond what many users do. GDP members are encouraged to report any and all bugs of all sorts (including broken documentation links, missing About pages, etc.). The Bug Buddy application is recommended for bug submissions as it is easier to use and provides more information to the developers.
Check with your distribution to get the required DocBook packages. You will need docbook-utils and docbook-dtds, and basic XML/SGML processing tools, as well as Scrollkeeper. If you use Emacs, you may find XSlide, and XSL major mode, helpful.
Check with your distribution to install the gtk-doc or gtkdoc package, which builds API docs from your source code. The API documentation page has a good summary of the gtk-doc process.
A great reference book for DocBook. Available in print and on the web.
These scripts are for converting documents from other formats into DocBook.