Documentation Primer/Manual

 

Information
These pages are being transferred from UserBase. Please don't work on them until the transfer is complete, and the old UserBase pages have been removed.

The KDE Documentation Primer

Revision 0.02

Date: 2005-05-21

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

Table of Contents

1. Introduction
2. Getting Started
   1. Things You'll Need
3. KDE Writing Recommendations and Guidelines
   1. Writing for your Audience
   2. English Usage Guidelines and Recommendations
   3. What to Include
4. Writing Documentation: Procedures and Tools
   1. Getting the Documentation Sources
   2. Kate
   3. Emacs and PsgmlEmacs and Psgml
   4. Checking and Viewing the Documents
5. DocBook Introduction
   1. Overview
   2. Content and Presentation
   3. KDE Specialities
6. Sending the New Documents and Changes to KDE
   1. Respecting the Release Schedule
   2. Working With Other Documenters and Developers
   3. Updating Documentation
   4. Licenses for KDE Documentation
   5. Using bugs.kde.org
7. Appendix A. DocBook Reference
8. Appendix B. The KDE Visual Guide