Difference between revisions of "Documentation Primer/Manual"

Jump to: navigation, search
(Corrected links)
m
 
Line 5: Line 5:
  
 
<!--T:2-->
 
<!--T:2-->
Revision 0.02
+
Revision 0.03
  
 
<!--T:3-->
 
<!--T:3-->
Date: 2005-05-21
+
Date: 2013-05-01
  
 
<!--T:4-->
 
<!--T:4-->
 
This document tells you everything (hopefully!) you need to know to start
 
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]
+
writing documentation for KDE. Please report any errors or omissions to [mailto:kde-doc-english@kde.org kde-doc-english@kde.org]
  
 
== Table of Contents == <!--T:5-->
 
== Table of Contents == <!--T:5-->

Latest revision as of 19:11, 1 June 2013

Other languages:English 100%

[edit] The KDE Documentation Primer

Revision 0.03

Date: 2013-05-01

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

[edit] 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

This page was last modified on 1 June 2013, at 19:11. This page has been accessed 1,814 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal