Difference between revisions of "Documentation Primer/Manual/Introduction"

Jump to: navigation, search
Line 1: Line 1:
<languages />
<languages />

Revision as of 08:25, 2 September 2012

Other languages:


The objective of this guide is to present all information required to make the experience of writing KDE documentation as easy as possible. The next chapter gives some information about what skills you'll need for the task. It is important to note that this guide is a joint effort of the KDE English Documentation Team and the KDE Quality Team. You can ask for support from both teams at any time.

The KDE English Documentation Team exists to provide end-user documentation for the whole of KDE. It's a big task, but an important one. Although KDE aims to be easy to use, not everything is obvious without some help, and, in a project this big, even an experienced user cannot know every corner of KDE.

The team is made up of people doing several different tasks:

  • Writing documentation for individual applications
  • Writing wider documentation for the whole of KDE (like the User Guide, or this document).
  • Proofreading and/or updating documentation to ensure that it is correct and up-to-date.

Contributors to all of these areas are always welcome. You can choose the area you would like to contribute to, based on your skills and what you enjoy doing. If you need any help with documentation issues, do not hesitate to ask at the KDE Documentation mailing list, kde-doc-english@kde.org or on IRC in the channel #kde-docs on irc.freenode.net.

The KDE Quality Team provides support for new contributors, and to coordinates the efforts of the volunteers. The KDE TechBase Quality Team provides guides to help you with some general development tasks, such as getting the sources, Building KDE From Source Step By Step, and Working with svn, etc.