Difference between revisions of "Projects/Documentation"

Jump to: navigation, search
(Moving KDE 4 doc info to this page)
Line 1: Line 1:
 
{{Template:I18n/Language Navigation Bar|Projects/Documentation}}
 
{{Template:I18n/Language Navigation Bar|Projects/Documentation}}
Documentation for KDE
+
KDE文档
  
 
[[Projects/Documentation/ProjectSuggestions|Project Suggestions]]: a list of suggestions for future Documentation projects. If you're a documenter, and in need of something to do, pick a suggestion and see what you can come up with!
 
[[Projects/Documentation/ProjectSuggestions|Project Suggestions]]: a list of suggestions for future Documentation projects. If you're a documenter, and in need of something to do, pick a suggestion and see what you can come up with!
  
= Documentation Resources =
+
= 文档资源 =
 
KDE developers and documentors have spent a great deal of time creating resources needed for a new contributor to be able to pick up how things are done with documentation and should answer any question you may have. On top of the documented resources located at [http://l10n.kde.org/docs/ Documentation Writing] there are also other resources and tools located in the KDE Subversion directories. These tools and resources can be located in the KDE trunk at KDE/kdelibs/kdoctools [http://websvn.kde.org/trunk/KDE/kdelibs/kdoctools/ WEBSVN Location].
 
KDE developers and documentors have spent a great deal of time creating resources needed for a new contributor to be able to pick up how things are done with documentation and should answer any question you may have. On top of the documented resources located at [http://l10n.kde.org/docs/ Documentation Writing] there are also other resources and tools located in the KDE Subversion directories. These tools and resources can be located in the KDE trunk at KDE/kdelibs/kdoctools [http://websvn.kde.org/trunk/KDE/kdelibs/kdoctools/ WEBSVN Location].
  
= KDE 4 Documentation =
+
= KDE 4 文档 =
KDE 4 is the next major milestone and release for the KDE project. With this new release, due out towards the end of 2007, comes a great amount of additions, changes, and fixes in order to provide users with the tools needed in order to maintain their KDE system.
+
  
== Background and Requirements ==
+
KDE 4是KDE项目下一个重要里程碑。由于2007年底发布的这个新版本,将会带来大量的补充,修改,修正的工作,以便为用户提供维护KDE的系统所需的工具,以维持其KDE的系统。
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 ==
+
== 背景和需求 ==
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.
+
随着大量对KDE 4文件的需要,各种技能组合都被大量需求。无论你是经验丰富熟悉DocBook和XML的技术作家或您是刚开始使用KDE和/或Linux ,总有一个任务等着你。这些任以促进KDE文档的进一步改善。这些要求英语阅读和书写能力。这样就大功告成了
  
=== Beginner ===
+
== 任务列表 ==
 +
现有的任务从典型的拼写和语法检查,到所有的创造并维护新的应用程序文件的行为动。这份文件将设法提供任务给不同层次的经验的人员,同时本文件将继续改进,以涵盖所有可能的任务,从而实现我们的目标。
 +
 
 +
=== 初级 ===
 
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.
 
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>
 
To see a list of Beginner level tasks, please review <INSERT PAGE NAME & LINK>
  
=== Intermediate ===
+
=== 中级===
 
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.
 
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.
  
 
To see a list of Intermediate level tasks, please review <INSERT PAGE NAME & LINK>
 
To see a list of Intermediate level tasks, please review <INSERT PAGE NAME & LINK>
  
=== Advanced ===
+
=== 高级===
 
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.
 
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>
 
To see a list of Advanced level tasks, please review <INSERT PAGE NAME & LINK>
  
= KDE Tasks =
+
= KDE任务 =
A list of KDE 4 documentation tasks are listed [[Projects/Documentation/KDE4|HERE]].
+
KDE 4文档任务列表: [[Projects/Documentation/KDE4|这里]].

Revision as of 10:54, 13 February 2009


Contents

Projects/Documentation

KDE文档

Project Suggestions: a list of suggestions for future Documentation projects. If you're a documenter, and in need of something to do, pick a suggestion and see what you can come up with!

文档资源

KDE developers and documentors have spent a great deal of time creating resources needed for a new contributor to be able to pick up how things are done with documentation and should answer any question you may have. On top of the documented resources located at Documentation Writing there are also other resources and tools located in the KDE Subversion directories. These tools and resources can be located in the KDE trunk at KDE/kdelibs/kdoctools WEBSVN Location.

KDE 4 文档

KDE 4是KDE项目下一个重要里程碑。由于2007年底发布的这个新版本,将会带来大量的补充,修改,修正的工作,以便为用户提供维护KDE的系统所需的工具,以维持其KDE的系统。

背景和需求

随着大量对KDE 4文件的需要,各种技能组合都被大量需求。无论你是经验丰富熟悉DocBook和XML的技术作家或您是刚开始使用KDE和/或Linux ,总有一个任务等着你。这些任以促进KDE文档的进一步改善。这些要求英语阅读和书写能力。这样就大功告成了

任务列表

现有的任务从典型的拼写和语法检查,到所有的创造并维护新的应用程序文件的行为动。这份文件将设法提供任务给不同层次的经验的人员,同时本文件将继续改进,以涵盖所有可能的任务,从而实现我们的目标。

初级

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>

中级

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 English Breakfast Network or EBN[1] for short.

To see a list of Intermediate level tasks, please review <INSERT PAGE NAME & LINK>

高级

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>

KDE任务

KDE 4文档任务列表: 这里.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal