docs.kde.org
A Note on Your Project Documentation
Prev
Next

A Note on Your Project Documentation

The KDE project uses docbook for generating your project handbook (i.e. the user manual). The user manual is available through your application menubar by choosing Help->YourApplication Handbook when your KDE GUI application is running. After building your project, the user manual is displayed in KDE KHelpCenter. It should explain to the user how your application works, what are the main features and how to configure it. It should also explain the advanced features if any.

All KDE based templates in KDevelop have a doc subdir which contains a index.docbook template in the en folder to get you started in writing the user manual. You should edit this index.docbook in KDevelop and start changing personal details such as name, email, etc.. Look at the comments in this file and try following these indications to start your application documentation. Rebuild your project to see the changes in KHelpCenter.

Note

You need to install your project using Build->Install or Install (as root user) in KDevelop to see the user manual in KHelpCenter.

You can find more about the docbook syntax on the KDE documentation website.

Prev
Next
Home


docs.kde.org