DocumentationTeam

Differences between revisions 30 and 31
Revision 30 as of 2007-09-05 16:52:22
Size: 8227
Editor: 89
Comment: Linked to Bazaar docs
Revision 31 as of 2007-10-10 12:52:57
Size: 7794
Editor: 218
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#title Documentation Team #title 文档 团队
Line 6: Line 6:
= Introduction = = 引言 =
Line 12: Line 12:
The '''Documentation Team''' is a group of community volunteers who manage the documentation that ships with the Ubuntu operating system, as well as the community-developed documentation on the documentation website at https://help.ubuntu.com/community. 文档团队是一群社区志愿者管理文件从而与ubuntu的操作系统相协同,以及社区开发的文件,其网站网址https://help.ubuntu.com/community。
Line 14: Line 14:
Our work consists of writing, editing and updating the system documentation for Ubuntu, as well as gathering the helpful advice from the Ubuntu Mailing-lists and Web Forums for all to use. 我们为Ubuntu所做的的工作分为写作,编辑和更新系统文件,以及从ubuntu的邮寄名单和网上论坛搜集有用的意见,为所有人使用。
Line 16: Line 16:
New contributors and members are always welcome. People are needed mostly for writing and editing, but there are many other ways of making a useful contribution. For example, simply pointing out errors (such as typos, grammar and spelling, and technical errors) is an extremely useful way to help. 新的捐助者和成员都是欢迎的。大家做出贡献的方法主要是写作和编辑,但也有许多其他途径作出有益的贡献。举例来说,简单地指出错误(例如类型,语法和拼写,以及技术性错误)是帮助我们改进的一个非常有用的方法。
Line 18: Line 18:
= Contact =
= 联络 =
Line 21: Line 22:
 * Most communication happens on the Documentation Team '''[http://lists.ubuntu.com/mailman/listinfo/ubuntu-doc mailing list]'''.
 * Join the '''#ubuntu-doc''' IRC channel on irc.freenode.net.
 * 大家大多数沟通是在文档小组的邮件列表。
'''[http://lists.ubuntu.com/mailman/listinfo/ubuntu-doc mailing list]'''.
 * 加入到 '''#ubuntu-doc''' IRC channel on irc.freenode.net.
Line 25: Line 27:
= How to Contribute = = 如何贡献 =
Line 29: Line 31:
The Documentation Team is always looking for new contributors. See below for a list of ways that you can help out. 文档团队一直在寻找新的贡献者。见下列表方式,你可以帮忙。
Line 31: Line 33:
== Join the mentoring programme == == 参加辅导方案 ==
Line 33: Line 35:
A great way to get involved with writing documentation is to join '''DocuMENTORS''', our mentoring programme. An experienced member of the Documentation Team will be available to help you get started and to answer your questions. 一个很棒的方式就是加入到'''DocuMENTORS'''撰写文件,我们的指导方案。一位资深的文档团队成员将可帮助你,并回答大家的提问。
Line 35: Line 37:
See [:DocumentationTeam/Mentoring:Mentoring] for more information. [:DocumentationTeam/Mentoring:Mentoring] 获得更多信息。
Line 37: Line 39:
== Improve the documentation wiki == == 必进文档的wiki ==
Line 39: Line 41:
The documentation wiki at '''[http://help.ubuntu.com help.ubuntu.com]''' is where the bulk of the Ubuntu community documentation is kept. Anyone can edit the wiki, which makes it an ideal place to start contributing. 文档的wiki在 '''[http://help.ubuntu.com help.ubuntu.com]''' 保持与Ubuntu文件的一致无误。 任何人都可以编辑wiki,这使它成为做出贡献的理想的地方。

 * 修改拼写和格式错误
 * 简化长页结构
 * 组织乱七八糟的页面,使它们易于阅读
 * 修复中断的链接
 * 添加新的文档到 wiki
Line 41: Line 49:
 * Fix spelling and formatting errors
 * Simplify the structure of long pages
 * Organize untidy pages so that they are easy to read
 * Fix broken links
 * Add new documentation to the wiki
其中有被列为需要改进的,在这里可以查询 [http://help.ubuntu.com/community/CategoryCleanup CategoryCleanup]. 同样,这里[https://help.ubuntu.com/community/WikiToDo Wiki ToDo list] 可以看到需要优先改善的待办事项的清单列表。
Line 47: Line 51:
A list of pages which have been identified as needing improvement can be found in [http://help.ubuntu.com/community/CategoryCleanup CategoryCleanup]. Also, see the [https://help.ubuntu.com/community/WikiToDo Wiki ToDo list] for a list of high-priority improvements which are required. 在你为 wiki 做出贡献之前, 你应该阅读 [https://help.ubuntu.com/community/WikiGuide Wiki Guide] 就如何知道如何正确的编辑页面了。
Line 49: Line 53:
Before you start contributing to the wiki, you should read the [https://help.ubuntu.com/community/WikiGuide Wiki Guide] for information on how to edit pages correctly. == 检查系统文件错误 ==
Line 51: Line 55:
== Check the system documentation for errors == 系统文件是指预先安装好ubuntu的帮助文件。点击 '''系统(System)''' -> '''帮助和支持(Help and Support)''' 可以查看系统文件.
Line 53: Line 57:
System documentation refers to the help files which are pre-installed on Ubuntu. Click '''System''' -> '''Help and Support''' to view the system documentation. 你可以以一种重要(和容易)的方式进行帮助,那就是找到阅读系统文件时发现的任何错误并报告我们。
Line 55: Line 59:
An important (and easy) way of helping out is to proof-read the system documentation and report any errors that you find.
Line 57: Line 60:
 * Follow the instructions given in the documentation to see if they work and if they make sense
 * Click links to make sure that they still work
 * Report spelling and grammar mistakes, mis-translated words and typos
 * Report documentation that you think is missing or inadequate
 * 遵照文件中给出的指示,看看它们的运行以及他们是否讲得通 * 查询链接,确保他们的链接有效
 * 报告拼写和语法错误,误译词和类型
 * 报告你认为错误或不足的文档
Line 62: Line 64:
You can file bug reports on [https://bugs.launchpad.net/products/ubuntu-doc/+filebug Launchpad] if you find a problem. See [https://help.ubuntu.com/community/ReportingBugs Reporting Bugs] for more information on how to file bugs correctly. 如果你发现了一个问题,你可以提交错误(或bug)报告 [https://bugs.launchpad.net/products/ubuntu-doc/+filebug Launchpad] . [https://help.ubuntu.com/community/ReportingBugs Reporting Bugs] 获得更多如何正确的报告漏洞的信息。
Line 64: Line 66:
Alternatively, you can make suggestions on improving the documentation on the [https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc Documentation Team mailing list]. 另外,你也可以提出建议如何更好的完善文档[https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc Documentation Team mailing list].
Line 66: Line 68:
== Import documentation from the forums == == 论坛中的精华文档 ==
Line 68: Line 70:
The [http://ubuntuforums.org/ Ubuntu Forums] contain a wealth of helpful guides on hundreds of different topics. It would be useful to store a lot of this information permanently on the wiki. You can help out by taking guides posted on the forums and turning them into wiki pages on the help wiki. 这 [http://ubuntuforums.org/ Ubuntu Forums] 包括数百个丰富的有用的主题。这将是有用的,很多这方面的资料可以永久的在wiki上查到。 你可以在论坛发表张贴有用的贴来帮助他人的工作,并将有用的变成wiki中的有用信息。
Line 70: Line 72:
 * Identify useful documentation on the forums
 * Enhance existing wiki pages using information from the forums
 * Create new wiki pages based on forum guides
 * Ask the authors of guides for permission to use their guides on the wiki
 * 找出论坛中有用的文档
 * 从论坛获得有用的信息来加强现有的wiki页面
 * 基于论坛指南创建新的wiki页面
 * 询问文档指南作者是否许可在wiki上使用他们的指南
Line 75: Line 77:
See the [https://help.ubuntu.com/community/forum Forum Importing page] for guidance on how to import forum guides correctly. [https://help.ubuntu.com/community/forum Forum Importing page] 就如何引进论坛指南,获得正确引导。
Line 77: Line 79:
== Work on the system documentation == == 从事于系统文档 ==

Include(DocumentationTeam/MenuBar)

引言

文档团队是一群社区志愿者管理文件从而与ubuntu的操作系统相协同,以及社区开发的文件,其网站网址https://help.ubuntu.com/community。

我们为Ubuntu所做的的工作分为写作,编辑和更新系统文件,以及从ubuntu的邮寄名单和网上论坛搜集有用的意见,为所有人使用。

新的捐助者和成员都是欢迎的。大家做出贡献的方法主要是写作和编辑,但也有许多其他途径作出有益的贡献。举例来说,简单地指出错误(例如类型,语法和拼写,以及技术性错误)是帮助我们改进的一个非常有用的方法。

联络

如何贡献

文档团队一直在寻找新的贡献者。见下列表方式,你可以帮忙。

参加辅导方案

一个很棒的方式就是加入到DocuMENTORS撰写文件,我们的指导方案。一位资深的文档团队成员将可帮助你,并回答大家的提问。

见 [:DocumentationTeam/Mentoring:Mentoring] 获得更多信息。

必进文档的wiki

文档的wiki在 [http://help.ubuntu.com help.ubuntu.com] 保持与Ubuntu文件的一致无误。 任何人都可以编辑wiki,这使它成为做出贡献的理想的地方。

  • 修改拼写和格式错误
  • 简化长页结构
  • 组织乱七八糟的页面,使它们易于阅读
  • 修复中断的链接
  • 添加新的文档到 wiki

其中有被列为需要改进的,在这里可以查询 [http://help.ubuntu.com/community/CategoryCleanup CategoryCleanup]. 同样,这里[https://help.ubuntu.com/community/WikiToDo Wiki ToDo list] 可以看到需要优先改善的待办事项的清单列表。

在你为 wiki 做出贡献之前, 你应该阅读 [https://help.ubuntu.com/community/WikiGuide Wiki Guide] 就如何知道如何正确的编辑页面了。

检查系统文件错误

系统文件是指预先安装好ubuntu的帮助文件。点击 系统(System) -> 帮助和支持(Help and Support) 可以查看系统文件.

你可以以一种重要(和容易)的方式进行帮助,那就是找到阅读系统文件时发现的任何错误并报告我们。

  • 遵照文件中给出的指示,看看它们的运行以及他们是否讲得通 * 查询链接,确保他们的链接有效
  • 报告拼写和语法错误,误译词和类型
  • 报告你认为错误或不足的文档

如果你发现了一个问题,你可以提交错误(或bug)报告 [https://bugs.launchpad.net/products/ubuntu-doc/+filebug Launchpad] . 见 [https://help.ubuntu.com/community/ReportingBugs Reporting Bugs] 获得更多如何正确的报告漏洞的信息。

另外,你也可以提出建议如何更好的完善文档[https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc Documentation Team mailing list].

论坛中的精华文档

这 [http://ubuntuforums.org/ Ubuntu Forums] 包括数百个丰富的有用的主题。这将是有用的,很多这方面的资料可以永久的在wiki上查到。 你可以在论坛发表张贴有用的贴来帮助他人的工作,并将有用的变成wiki中的有用信息。

  • 找出论坛中有用的文档
  • 从论坛获得有用的信息来加强现有的wiki页面
  • 基于论坛指南创建新的wiki页面
  • 询问文档指南作者是否许可在wiki上使用他们的指南

见[https://help.ubuntu.com/community/forum Forum Importing page] 就如何引进论坛指南,获得正确引导。

从事于系统文档

The Ubuntu system documentation is produced in the DocBook XML format and is hosted in the Documentation Team's [https://docteam.ubuntu.com/repos/ SVN repository]. You can help out by maintaining and improving the documentation.

  • See [:DocumentationTeam/Contribute:Contribute] for an outline of what is involved in editing the system documentation.

  • See [:DocumentationTeam/Repository:Repository] and [:DocumentationTeam/SVN:SVN] for information on using the SVN repository.

  • See [:DocumentationTeam/Bazaar:Bazaar] for information on using the DocTeam Bazaar branches.

  • See [:DocumentationTeam/DocbookTags:Docbook Tags] for an introduction to writing documentation in DocBook

As well as the general system documentation, there are also several guides which are maintained by the Documentation team which you can contribute to. Check the projects list below, and go to the [:/GettingStarted:Getting Started] page to learn more.

Projects

The Documentation Team maintains the help system for the Ubuntu, Kubuntu and Edubuntu desktops, as well as specific guides on Ubuntu Server and Switching From Windows. New versions of these guides are released with each new release of Ubuntu, and these are translated through the translation tool Rosetta in the same manner as all of the other applications in Ubuntu.

For a complete list of these projects and the community members who are currently maintaining them, see our [:DocumentationTeam/Projects:Projects page].

You can see the currently available documentation here:

Launchpad Membership Policy

Members of the Documentation Team on Launchpad are those who have upload rights to the documentation repository. Rights are granted by current Documentation Team administrators after some substantial contribution to the project has been demonstrated by sending patches. You can apply for membership on the [https://launchpad.net/~ubuntu-doc team Launchpad page].

Meetings

Ubuntu Documentation Team meetings are announced on the ubuntu-doc mailing list and normally take place in the #ubuntu-meeting IRC channel on irc.freenode.net. You can find the agenda and time for the next meeting at the [:DocumentationTeam/MeetingAgenda] page.

Summaries from previous Documentation Team meetings can be found on the MeetingLogs page.

Sub-pages

This Team wiki page contains the following sub-pages:

Navigation(children,1)


CategoryDocteam CategoryUbuntuTeams

DocumentationTeam (last edited 2021-06-11 05:29:18 by roguescholar)