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.

    This is required for all KDE applications that you at a minimum cover any application specific menu entries, and strongly recommended that you cover all the standard ones too (in case users are reading the manual outside of KDE, or yours happens to be the first one they read, and it provides consistency. Cut and paste is your friend here.)

    Note that although this is a required section, and for some applications it is the only section, it should be considered a minimum.

  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.

    This chapter is required for all KDE documents, and must have at least the two license links (one for the document, and one for the application)

  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 trunk/KDE/kdelibs/kdoctools/template.docbook file in KDE Subversion repository.