Create a new Knowledge Base article
Revision Information
- Revision id: 119276
- Created:
- Creator: AliceWyman
- Comment: added screenshots and other edits
- Reviewed: No
- Ready for localization: No
Revision Source
Revision Content
To create a new article, right-click and open 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:
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).
- 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!
- Click 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
- You'll be asked to "Briefly describe your changes."
.
- Type in some basic information about your article in the box that pops up and press .
If this is a new article and you still 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.
The code below is an example of the most common wiki markup you can use in the content section of your new article. For more markup, see the Markup chart.
Introduction goes here.
__TOC__
=First section=
An unordered list:
*First item. For more information, see [[Name of article]]
*[[Name of article|Second item]]
*:[[Image:Name of image]]
{note}'''Note:''' This is an example of a note.{/note}
=Second section=
{for win}
A numbered list only "for" Windows users:
#First item
#Second item
{/for}
{for mac}
A numbered list only "for" Mac users:
#First item
#Second item
{/for}
{for linux}
A numbered list only "for" Linux users:
#First item
#Second item
{/for}
{warning}'''Warning:''' This is an example of a warning.{/warning}
Article writing documentation
If you're serious about writing articles for Mozilla Support, here are a few 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).
- Writing guide for Knowledge Base articles — is a guide to writing techniques and styles that we use to make articles more engaging and effective.
- When and how to use keywords to improve an article's search ranking — explains when adding keywords to an article is appropriate.
- Add images and screenshots to Knowledge Base articles — is a step-by-step guide to creating screenshots and including them in articles.
- Add images and screenshots to Knowledge Base articles — explains how to get screenshots and other images to display correctly in articles.
- Markup chart — lists the wiki markup we use in writing articles.
- How to use {for} — this is the special wiki markup that lets us show instructions for different application versions (for example, Firefox 40) and operating systems such as Windows and Mac OS.
- 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.