What to Include

For most applications, a structure something like this would be appropriate:

  1. Introduction: A basic description of what the application does and any noteworthy features, etc..

  2. Using KApp: Task-based description of the most common uses of the application.

  3. Program reference: Description of all of the features of the application. This would usually include a menu reference, but might also include command line options, syntax description, etc., if they are appropriate to the application.

  4. Frequently Asked Questions: List the most common questions and problems that users have with the application, and their solutions. “How do I ...?”-type questions are especially appropriate.

  5. Credits and License: A list of those who contributed to the documentation, and a link to the GNU Free Documentation License, under which all KDE documentation is licensed.

  6. Installation: This chapter can be automatically generated, provided that the application follows the usual KDE compilation procedure (i.e. ./configure, make && make install). If you need to add extra information about compiling or installing the application, it can go here.

You will find a template document with these sections in kdelibs/kdoctools/template.docbook in KDE CVS.