Compare Revisions

How to contribute to the Knowledge Base

Revision 277033:

Revision 277033 by lsiebert on

Revision 278297:

Revision 278297 by lsiebert on

Keywords:

Search results summary:

Learn how you can contribute to Mozilla Support by writing or improving support articles.
Learn how you can contribute to Mozilla Support by writing or improving support articles.

Content:

<!--need to replace this so Michael doesn't get inundated with emails [[Video:http://youtu.be/y4B5UDW_D9s]]--> Thanks for your interest to help with our Knowledge Base. For millions of people around the world, these articles are the face of Mozilla when they have a problem or question about one of our products. Improving the Knowledge Base is the way to get the biggest bang for our collective effort. A single article can quickly help tens of thousands of people each week. <!-- __TOC__ --> In general, there are two ways you can contribute to the Knowledge Base: = Write new support articles = Are there [/products support topics for Mozilla products] we haven't covered? You can do a [/search search] to find Knowledge Base articles that already exist. <!-- {note}'''Tip:''' A great place to get started is with one of these '''[/en-US/questions?tagged=needsdoc support forum solutions that need to be documented]'''.{/note} --> = Help us improve existing articles = The most common thing we do in the glamorous world of Knowledge Base maintenance is to try to improve the articles we already have. {note}'''Before you write or edit an article, make sure to read [[About the Knowledge Base]].'''{/note} If you're really interested in editing and writing documentation, here are a few resources that should help explain how we do things: '''Create new support articles''' * [[Writing guide for Knowledge Base articles]] — Guide to writing techniques and styles that we use to make articles more engaging and effective. For the mechanics of actually creating or editing articles, see: ** [[Create a new Knowledge Base article]] – Steps for creating a new article along with some sample wiki markup to get you started ** [[Anatomy of a Knowledge Base article]] – Explains the basics of how articles are built ** [[Article Description]] - Explains how to write description for a support article '''Improve existing support articles''' * [[Improve the Knowledge Base]] - Learn how to improve SUMO Knowledge Base * [[Edit a Knowledge Base article]] - Steps for editing an existing article '''Other guidelines''' * [[About the Knowledge Base]] — An overview of the mechanics of our Knowledge Base * [[Article Review Guidelines]] — Reviewer guidelines for Knowledge Base * [[How to make screenshots]] — A step-by-step guide to creating screenshots to use in articles * [[Add images and screenshots to Knowledge Base articles]] — Explains how to add and get screenshots and other images to display correctly in articles * [[Markup cheat sheet]] – The most commonly used wiki markup in our articles * [[Markup chart]] — Wiki markup reference. It gives examples and shows the markup that produces them * [[How to use For|How to use <nowiki>{</nowiki>for}]] — Special wiki markup that lets us show instructions ''for'' different application versions (for example, Firefox 90) and operating systems such as Windows and macOS. * [[Using Templates]] — Templates are reusable pieces of content. You can include a complicated set of step-by-step instructions in multiple articles by using a template. * [[When and how to use keywords to improve an article's search ranking]] — Explains when adding keywords to an article is appropriate * To see more guidelines on Knowledge Base contribution, click [https://support.mozilla.org/en-US/products/contributor/kb here].
<!--need to replace this so Michael doesn't get inundated with emails [[Video:http://youtu.be/y4B5UDW_D9s]]--> Thank you for your interest in contributing to our Knowledge Base. This resource serves as a vital link between Mozilla and millions of users worldwide, offering support and answers for their product-related queries. The active participation of our community is crucial for the Knowledge Base to thrive, directly impacting the assistance provided to tens of thousands of users every week. <!-- __TOC__ --> Broadly speaking, there are two main pathways through which you can contribute to the Knowledge Base: = Write new support articles = Are there [/products support topics for Mozilla products] we haven't covered? You can do a [/search search] to find Knowledge Base articles that already exist. <!-- {note}'''Tip:''' A great place to get started is with one of these '''[/en-US/questions?tagged=needsdoc support forum solutions that need to be documented]'''.{/note} --> = Help us improve existing articles = The most common thing we do in the glamorous world of Knowledge Base maintenance is to try to improve the articles we already have. {note}'''Before you write or edit an article, make sure to read [[About the Knowledge Base]].'''{/note} If you're really interested in editing and writing documentation, here are a few resources that should help explain how we do things: '''Create new support articles''' * [[Writing guide for Knowledge Base articles]] — Guide to writing techniques and styles that we use to make articles more engaging and effective. For the mechanics of actually creating or editing articles, see: ** [[Create a new Knowledge Base article]] – Steps for creating a new article along with some sample wiki markup to get you started ** [[Anatomy of a Knowledge Base article]] – Explains the basics of how articles are built ** [[Article Description]] - Explains how to write description for a support article '''Improve existing support articles''' * [[Improve the Knowledge Base]] - Learn how to improve SUMO Knowledge Base * [[Edit a Knowledge Base article]] - Steps for editing an existing article '''Other guidelines''' * [[About the Knowledge Base]] — An overview of the mechanics of our Knowledge Base * [[Article Review Guidelines]] — Reviewer guidelines for Knowledge Base * [[How to make screenshots]] — A step-by-step guide to creating screenshots to use in articles * [[Add images and screenshots to Knowledge Base articles]] — Explains how to add and get screenshots and other images to display correctly in articles * [[Markup cheat sheet]] – The most commonly used wiki markup in our articles * [[Markup chart]] — Wiki markup reference. It gives examples and shows the markup that produces them * [[How to use For|How to use <nowiki>{</nowiki>for}]] — Special wiki markup that lets us show instructions ''for'' different application versions (for example, Firefox 90) and operating systems such as Windows and macOS. * [[Using Templates]] — Templates are reusable pieces of content. You can include a complicated set of step-by-step instructions in multiple articles by using a template. * [[When and how to use keywords to improve an article's search ranking]] — Explains when adding keywords to an article is appropriate * To see more guidelines on Knowledge Base contribution, click [https://support.mozilla.org/en-US/products/contributor/kb here].

Back to History