Toggle the table of contents

Projects/Documentation/KDE: Difference between revisions

From KDE TechBase

Latest revision as of 10:54, 8 November 2023

Warning

The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.

KDE Documentation Tasks

The following task list is broken down by experience as closely as possible. It is recommended that you get in touch with the team and coordinate with the other members so as not to create any problems or duplicate work. Currently the channel is quite slow and quiet.

If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.

If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at the mail manager and say hello. Maybe provide a little bit of information as well as your experience.

Beginner

Documentation Primer

Here is a comprehensive manual about KDE DocBooks creating.

Useful Links on Wikis

Health Table. Please do not hesitate to improve it.
Current release schedule and feature plan

Intermediate

Advanced

KMail

Location: KMail docbook
Status: Needs a lot of updating and new material. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
Status Update: Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
Info: Check with Allen Winter (winterz) on IRC

KOrganizer

Location: KOrganizer docbook
Status: Needs a lot of updating and new material
Info: Check with Allen Winter (winterz) on IRC

Retrieved from "https://techbase.kde.org/index.php?title=Projects/Documentation/KDE&oldid=107156"

@@ Line 1: / Line 1: @@
-= KDE 4 Documentation =
+{{Warning | The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.}}
-== Background and Requirements ==
-With the amount of work required in order to get KDE 4 documentation where it needs to be, there are tasks available for all sorts of skill sets. Whether you are the seasoned technical writer familiar with DocBook and XML or you are someone who just started using KDE and/or Linux, there is a task waiting for you. There are requirements in order to contribute to the base documentation. These requirements are the ability to read and write clearly in English. That's it!
-== Task List ==
+= KDE Documentation Tasks =
-The available tasks start from typical spelling and grammar checking, all the way up to creating and maintaining documentation for new applications. This document will try to provide available tasks oriented towards the various levels of experience and this document will continue to expand in order to cover every possible task to reach our goal.
+The following task list is broken down by experience as closely as possible. It is recommended that you [https://community.kde.org/Get_Involved/documentation get in touch with the team] and coordinate with the other members so
+as not to create any problems or duplicate work. Currently the channel is quite slow and quiet.
-=== Beginner ===
+If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.
-The Beginner level will encompass the very basic tasks required in order to assist the KDE Documentation Project. These tasks will normally include spelling and grammar checking/fixing, readability, and if possible technical correctness. Spelling and Grammar checking/fixing is rather straight forward. Readability will require you to read through a document and report back if there are portions that are unclear or confusing. Technical correctness requires a little knowledge with KDE 4 and/or the application documentation you are reviewing. If you are unfamiliar with the technology being covered in the documentation, then it may be easier for you to adopt a task or document in which are more familiar with.
-To see a list of Beginner level tasks, please review <INSERT PAGE NAME & LINK>
+If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at [https://mail.kde.org/mailman/listinfo/kde-doc-english the mail manager] and say hello. Maybe provide a little bit of information as well as your experience.
-=== Intermediate ===
+== Beginner ==
-The Intermediate level will encompass tasks that are a bit more involved than the Beginner level tasks. Of course you will still utilize the requirements and jobs listed above in the Beginner level tasks. The Intermediate level tasks will require you to be a little more familiar with SVN (anonymous unless you have an account) as well as DocBook and XML. A great tool for the Intermediate level to utilize, as well as the Beginner level, is the [http://www.englishbreakfastnetwork.org/ English Breakfast Network] or EBN[1] for short.
+=== Documentation Primer ===
-To see a list of Intermediate level tasks, please review <INSERT PAGE NAME & LINK>
+Here is a [http://l10n.kde.org/docs/doc-primer comprehensive manual] about KDE DocBooks creating.
-=== Advanced ===
+=== Useful Links on Wikis ===
-The Advanced level will encompass tasks such as creating a document from scratch utilizing the DocBook/XML DTD and have full understanding of the KDE Style Guide as well as the community itself. Contributors that fall under the advanced level will also help those contributing at both the Beginner and Intermediate levels. A contributor in this level should be able to answer a majority of the questions asked by the previous 2 levels or should be able to locate an answer easily within the community.
-To see a list of Advanced level tasks, please review <INSERT PAGE NAME & LINK>
+* [[Projects/Documentation/KDE_(health_table)|Health Table]]. Please do not hesitate to improve it.
+* [https://community.kde.org/Schedules Current release schedule and feature plan]
+== Intermediate ==
+== Advanced ==
+=== KMail ===
+* '''Location:''' [https://commits.kde.org/kmail?path=doc/kmail/ KMail docbook]
+* '''Status:''' Needs a lot of updating and new material. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
+* '''Status Update:''' Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
+* '''Info:''' Check with Allen Winter (winterz) on IRC
+=== KOrganizer ===
+* '''Location:''' [https://commits.kde.org/korganizer?path=doc/ KOrganizer docbook]
+* '''Status:''' Needs a lot of updating and new material
+* '''Info:''' Check with Allen Winter (winterz) on IRC