HowTo write KOffice Documentation

KOffice Documentation Guidelines

• introduce the user to the workflow of each component
• fully describe the functionality, including examples and short tutorials
• use screenshots wherever appropriate - visually appealing documentation is better than just text
• contain a command reference that explains all menu items (including context menus)

Tips and Tricks

Here are some tips about your editor:

• set your editor to wrap lines at 80 characters
• open and save as utf8 in your editor
• choose the docbook syntax highlighting
• do not indent your docbook files

Screenshots: theme, style and color can be set in KControl. Theme and style are Plastik and color is KDE default.
Please use those KDE defaults as much as possible for consistent screenshots along with standard fonts.

Information on KDE Documentation