在任何重大规模上为MDN文档作出贡献的主要部分是知道如何作为MDN社区的一部分工作。本文提供的技巧可帮助您充分利用与其他作者和开发团队的互动。

一般礼仪准则

以下是在Mozilla社区工作时的一些通用指导原则。

  •  要有礼貌!即使意见不一致,我们都有相同的使命:网络的改善。     
  • 问,不要求。当你礼貌地请求帮助而不是要求帮助时,人们更有可能会对他们有帮助和回应。尽管文档工作很重要,而且我们的开发团队知道它,但是如果不尊重它们,人类的本能往往会导致人们磨损和困难。     
  • 平衡您对信息的需求和文档的紧迫性以及您讨论中的其他人必须致力于帮助您的时间。如果马上不是绝对必要的话,不要一直推动越来越多的细节,以至于让参与谈话的其他人变得疯狂。     
  • 请记住,您的请求需要宝贵的时间从您联系的人,所以一定要充分利用他们的时间。     
  • 体谅文化差异。 Mozilla是一个跨国和多元文化的团队,因此当与某个文化与自己或不同的人交谈时,务必在沟通时牢记这一点。     
  • 开始一个新的谈话,而不是劫持现有的谈话。不要将你的问题注入无关的对话中,因为你需要与之交谈的人正在关注它。虽然对您很方便,但这可能会刺激您想要与之交谈的人,并导致不理想的结果。     
  • 避免 bikeshedding。不要让你的热情变得恼人的琐事。它使对话变得繁琐而不重要。

委婉

与他人沟通时要时刻保持委婉和恭敬。

礼貌地指出错误

如果您在联系某人的目的是要求他们采取不同的做法,或者指出他们所犯的错误(特别是他们反复犯错的话),请以正面评论开始您的信息。这可以减轻打击,这可以说,它表明你试图帮助,而不是让你成为坏人。 例如,如果一个新的贡献者创建了大量没有标签的页面,并且您想要指出这个问题,那么您给他们的消息可能看起来像这样(您需要为每个个案更改的内容加下划线):

嗨,MrBigglesworth,我一直注意到你对Wormhole API文档的贡献,并且能够得到你的帮助真是太棒了!我特别喜欢你通过可读性平衡细节水平的方式。尽管如此,如果您在页面中添加正确的标签,您可以使这些文章更好,更有用。

详细信息,请参阅MDN标记指南 (https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Tag) 。

分享知识

在您参与MDN项目时,了解发生了什么以及与我们社区的其他成员进行互动很有用。通过与我们社区中的其他人交谈,您可以获得并分享想法,状态更新等。我们还拥有工具和信息资源,可以帮助您了解由谁来完成的工作。

沟通渠道

您可以通过多种方式与社区成员(开发人员或作者)进行交流,每种方式都有自己特定的礼仪规则。

IRC

这通常是最快和最直接的方法来处理某人:只需在IRC中ping通即可。找到与您正在撰写的主题区域相对应的频道,然后与他们交谈。有关IRC特定的礼仪提示,请参阅Mozilla支持文章“IRC入门”。有关开发人员文档的讨论,请使用#mdn通道。

Bugzilla

在编写文档以涵盖由于Bugzilla中的错误而实施的更改时,您经常会与涉及这些错误的人员进行交互。请务必始终牢记Bugzilla礼仪指南!

电子邮件

有时候,如果你有他们的电子邮件地址,你和一个或多个其他人之间的私人电子邮件交换就是要走的路。

注意:一般来说,如果有人在您要记录的技术文档上发布了他们的电子邮件地址,已经亲自给您发送了他们的电子邮件地址,或者通常有一个众所周知的电子邮件地址,则电子邮件是可接受的“第一次联系人”做法。如果你需要挖掘它,你可能应该首先尝试获得IRC或邮件列表的许可,除非你已经用尽了所有其他尝试取得联系的努力。

Content status tools

We have several useful tools that provide information about the status of documentation content.

Revision dashboard
The revision dashboard provides a fantastic tool to review changes made to MDN content. You can see recent history, choose a range of time to view, and filter based on things like locale, contributor's name, and topic. Once you're looking at a set of revisions, you can view the changes made in each revision, quickly open the page, see a full history, or even revert the changes (if you have those privileges).
Documentation status overview
Our documentation status overview page provides a list of all the areas of MDN that have been configured for status tracking, with information about how many pages therein need different types of work done. Click through to a particular topic area to see detailed lists of content that needs work, such as pages that have no tags, or are tagged with indicators that certain types of work need to be done. You can even see lists of pages that haven't been updated in a long time and may be out of date, as well as a list of bugs that have been flagged as impacting the documentation in that area.
Documentation project plans
We have a number of writing projects that are in the planning stages, or are large and ongoing, for which we have written planning documents to help us keep track of what we need to get done.
MDN Taiga
The MDN staff writers use a tool called Taiga to manage current and future documentation projects. You can take a look to see what we're doing and how it's going, and you can see what projects we'd like to see happen soon. Some of those will be taken on by staff writers, but you should feel free to take one over if you like! For more information about the agile processes followed by the MDN team, see our Process page on the Mozilla wiki.

The development community

Possibly the most important relationships to develop and maintain, as a member of the MDN writing community, are those you develop and sustain with the developers. They create the software we're developing, but they're also the most useful source of information we have. It's crucial that we maintain good relations with developers—the more they like you, the more likely they are to answer your questions quickly, accurately, and thoroughly!

In addition, you represent the MDN writing community. Please help ensure we keep our excellent working relationship with the dev team by making every interaction they have with the writing team be a good one.

On a related note, a great way to find the right person to talk to is to look at the module owners lists.

The writing community

The writing community is a large one. While the number of extremely frequent, or large-scale contributors is relatively small, there are many dozens or hundreds of people who contribute at least now and then. Fortunately, these are by and large awesome people with a genuine love of the Web, Mozilla, and/or documentation, and interacting with them is almost always pretty easy.

See the article Join the community for more information about the MDN community.

The most frequent place you'll directly interact with other writers is in the #mdn channel on IRC. This channel is specifically reserved for discussing documentation. For IRC-specific etiquette tips, see the Mozilla Support article "Getting Started with IRC." You'll also have discussions with us on the MDN discussion forum. In general, IRC tends to be used for quick, more in-person-like discussions, while the discussion forum is typically used for longer-duration conversation.

By keeping in mind the General etiquette guidelines, you'll find that usually things go very smoothly.

See also

文档标签和贡献者

标签: 
此页面的贡献者: wbamberg, huangzijian888
最后编辑者: wbamberg,