Compare Revisions

Guidelines and a template for creating a new article.

To create a new article, right-click and open '''[https://support.mozilla.org/en-US/kb/new this link]''' in a new tab. The ''Create a New Knowledge Base Article'' page will open. Here's what the top part of that page looks like: ;[[Image:ArticleDescription]] Don't be intimidated by all of the fields and checkboxes that you see when you first create a new article. Most everything can be handled later. This is all you really have to do: #Enter a '''title''' (can be changed later). More on article titles [[Write articles for the Knowledge Base#w_title|here]]. #Choose the product this article is '''relevant to''' (can be changed later). #Choose one '''topic''' (can be changed later). #Enter a '''search result summary''' (short description of the article). #Go to the '''Content''' box and start writing! #;[[Image:content-box]] #Click {button Preview Content} to see what your article will look like when it’s been published. #When you’re satisfied with your article's content and appearance, click {button Submit for Review}. #'''Briefly describe your changes''' in the Submit your Changes box that appears. If you have more work to do, you can type in "Work in progress". If you're ready for feedback and review, you can type in "Ready for review". #;[[Image:Submit article]] #Press {button Submit}. The code below is an example of how text might appear in in the '''content''' section of an article, using the most common wiki markup. For an explanation of common markup used in KB articles, see the [[Markup cheat sheet]]. For lots more markup, see the [[Markup chart]]. <code> Introduction goes here. <br><br> <nowiki>__TOC__</nowiki> <br><br> <nowiki>=First section=</nowiki><br> An unordered list:<br> <nowiki>*</nowiki>First item. For more information, see <nowiki>[[</nowiki>Name of article<nowiki>]]</nowiki><br> <nowiki>*</nowiki><nowiki>[[</nowiki>Name of article|Second item<nowiki>]]</nowiki><br> <nowiki>*:[[</nowiki>Image:Name of image<nowiki>]]</nowiki><br><br> <nowiki>{</nowiki>note<nowiki>}</nowiki><nowiki>'''</nowiki>Note:<nowiki>'''</nowiki> This is an example of a note.<nowiki>{</nowiki>/note<nowiki>}</nowiki> <br><br> <nowiki>=Second section=</nowiki><br> <nowiki>{</nowiki>for win<nowiki>}</nowiki><br> A numbered list only "for" Windows users:<br> <nowiki>#</nowiki>First item<br> <nowiki>#</nowiki>Second item<br> <nowiki>{</nowiki>/for<nowiki>}</nowiki><br><br> <nowiki>{</nowiki>for mac<nowiki>}</nowiki><br> A numbered list only "for" Mac users:<br> <nowiki>#</nowiki>First item<br> <nowiki>#</nowiki>Second item<br> <nowiki>{</nowiki>/for<nowiki>}</nowiki><br><br> <nowiki>{</nowiki>for linux<nowiki>}</nowiki><br> A numbered list only "for" Linux users:<br> <nowiki>#</nowiki>First item<br> <nowiki>#</nowiki>Second item<br> <nowiki>{</nowiki>/for<nowiki>}</nowiki><br><br> <nowiki>{</nowiki>warning<nowiki>}</nowiki><nowiki>'''</nowiki>Warning:<nowiki>'''</nowiki> This is an example of a warning.<nowiki>{</nowiki>/warning<nowiki>}</nowiki> </code> = Article writing documentation = If you're interested in writing articles for Mozilla Support, here are some resources that should help explain how we do things: *'''[[About the Knowledge Base]] '''— is an overview of the mechanics of our Knowledge Base (for example, prioritization and scheduling). *'''[[Write articles for the Knowledge Base]]''' — is a guide to writing techniques that make articles more engaging and effective. This article includes our [[Write articles for the Knowledge Base#w_style-guide-and-copy-rules|style guide and copy rules]]. *'''[[Improve the Knowledge Base]]''' — is our guide for new contributors. This article contains a [[Improve the Knowledge Base #w_complete-list-of-article-writing-documentation|complete list of article-writing documentation]].