Skip to content

The KDE Documentation Primer 

Sunday, 4 August 2019  |  The KDE Documentation Team

Abstract

This document tells you everything you need to know to start writing documentation for KDE. Please report any errors or omissions to kde-doc-english@kde.org.

Keywords: KDE, Writing, Documentation

Introduction

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 will need for the task.

The KDE English Documentation Team exists to provide end-user documentation for the whole of KDE. It is 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 can not 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 Fundamentals, 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.libera.chat.

Getting Started

KDE Writing Recommendations and Guidelines

Writing Documentation: Procedures and Tools

DocBook Introduction

Sending the New Documents and Changes to KDE

Credits and License

This documentation is licensed under the terms of the GNU Free Documentation License.

Appendix: DocBook Reference


Article contributed by , , , and under the GFDL-1.2-or-later license.