Porovnání revizí

Improve the Knowledge Base

Revize 5835:

Revize 5835 od uživatele Verdi z data

Revize 6367:

Revize 6367 od uživatele Verdi z data

Klíčová slova:

Souhrn výsledků vyhledávání:

Improve the Knowledge Base
Improve the Knowledge Base

Obsah:

<section> Improving the Knowledge Base is the way to get the biggest bang for your effort. Our top articles help tens of thousands of people each week. The better we make the articles in the KB the faster people get help, the less they need one-on-one support, and the better their overall experience will be. == Ready to get started?== As a nonprofit, open-source project, we rely on volunteers to write the majority of the articles. You don't need special permission to work on them – this is a wiki that anyone can edit. [/tiki-register.php All you need is an account]. Once you done that the best way to get started is talk to us: *[mailto:&#109;&#118;&#101;&#114;&#100;&#105;&#64;&#109;&#111;&#122;&#105;&#108;&#108;&#97;&#46;&#99;&#111;&#109; Email me], Michael, with any of your questions or just introduce yourself. I'd love to hear from you and help get you started. *Join us in the [http://support.mozilla.com/en-US/forums/knowledge-base-articles Knowledge Base articles forum]. This is where we discuss changes to articles and ways to improve the knowledge base. *Talk to us in the [irc://irc.mozilla.org/sumo #sumo IRC channel]. This is where Firefox Help contributors help each other. I'm michaelverdi in there. If you don't have an irc client, connect [https://www.mibbit.com/?server=irc.mozilla.org&channel=%23sumo via Mibbit]. ==How our wiki is different than others== *'''Wiki markup''' **Although we use MediaWiki markup (like Wikipedia) for most things, our wiki is designed specifically for Firefox Help and uses some custom markup for displaying instructions. See our [[Markup chart|markup chart]] for a list and examples. *'''Review system''' **Because we want to be sure that Firefox users get correct and up-to-date information, edits to our articles have to reviewed and approved before they become live. *'''Translations''' **We have a system for translating the English articles in our Knowledge Base into other languages. Translations are tied to their English source article and localizers are notified when it changes. For more information, see [[Translating articles]]. == Making our support articles better == The most common thing we do in the glamorous world of Knowledge Base maintenance is try to improve the articles we already have. With nearly 300 of them there's always something that can be made better. Here are three main ways to improve an article: *'''Make articles easier to understand''' **Find a better way to explain something that is too complex or not very clear. **Add screenshots to help people understand what in the world the article is referring to. Most people probably don't know the difference between the location bar, search bar or any other bar unless it has a happy hour. **Add screencasts. This is the next best thing to actually grabbing the mouse out of someone's hand and doing it for them. *'''Keep articles up-to-date''' – Major updates to Firefox always bring new features, and changes to how existing ones work. It's always best when our instructions actually match how things work in the product. *'''Proof-read''' – Some of you have special powers to spot the mistakes that spell-check misses (how many have you noticed in this article so far?). We need your help. **Correct spelling, grammar and punctuation. **Fix issues with style and formatting. See the SUMO Style section for our guidelines. == Links to more documentation about improving the Knowledge Base == * [[How we are different]]: Learn how we are different from other wikis. * [[Editing articles|How to edit articles]] * [[Markup chart|How to format articles]] * Learn about our [[Approving articles and edits|staging and approval system]] * [[Requesting an article]] * [[Knowledge Base Policies]] * [[Approvers]]: What are approvers, and who are they. * [[Group permissions|User permission levels]] * [[Best Practices for Support Documents]] * [[Style Guide|Manual of style]] * [[Using SHOWFOR]]: Learn how to show/hide content for specific operating systems or specific versions of Firefox. * [[Dynamic Content]]: Use dynamic content to insert content you've seen in many other articles. * [[Measuring knowledge base success]] * [[Using poll data to judge your edits]] * [[Creating articles|Create an article]] * (Approvers) [/tiki-browse_categories.php?parentId=11 Modified articles waiting for review] * (Approvers) [[Creating content blocks]] </section>
<!-- This intro section really should be a video --> Thanks for helping with our Knowledge Base articles. For millions of people around the world, these articles are the face of Mozilla when they have a problem or question about Firefox. Improving the Knowledge Base is the way to get the biggest bang for our collective effort. The top articles help tens of thousands of people each week so the better we make them, the less people need one-on-one support and the better their overall experience is. == Create an account and say hello == As a nonprofit, open-source project, we rely on volunteers to write the majority of the articles. You don't need special permission to work on them — this is a wiki that anyone can edit. [/tiki-register.php All you need is an account]. Once you've got one, the next thing you should do is say hello: *[mailto:&#109;&#118;&#101;&#114;&#100;&#105;&#64;&#109;&#111;&#122;&#105;&#108;&#108;&#97;&#46;&#99;&#111;&#109; Email me], Michael, and introduce yourself. I'd love to hear from you and help get you started. *Talk to us in the [irc://irc.mozilla.org/sumo #sumo IRC channel]. This is where Firefox Help contributors help each other. I'm michaelverdi in there. If you don't have an IRC client, connect [https://www.mibbit.com/?server=irc.mozilla.org&channel=%23sumo via Mibbit]. ==Get started! == The most common thing we do in the glamorous world of Knowledge Base maintenance is try to improve the articles we already have. The best way to get started is to join us in the [http://support.mozilla.com/en-US/forums/knowledge-base-articles Knowledge Base articles forum] and look for threads labeled "needs update," "needs review" or "proposed". These are discussions about writing or changing articles and feedback is always welcome. In addition to the Articles forum, here are a few resources that should help explain how we do things: *[[How the Knowledge Base works]] — is an overview of how our wiki is different from others, what kinds of topics we cover, how new articles are created and some ways you can make existing articles better. *[[How to write Knowledge Base articles]] — is a guide to writing techniques and styles that we use to make articles more engaging and effective. *[[Markup chart]] — is our wiki markup reference. It gives examples and shows the markup that produces them.

Zpět na historii