Article Description

Contributors Contributors Senast uppdaterad: 3 veckor, 2 dagar ago
Ingen har hjälpt till att översätta den här artikeln än. Om du redan vet hur översättning för SUMO fungerar, börja översätta nu. Om du vill lära dig hur man översätter artiklar för SUMO, vänligen börja här.

Before contributors can write the content for a new article, they must fill out a description. By categorizing an article like this, readers can find the article more easily. Here is how to do this.

Note: All contributors can include a description (title, category, relevant product, etc.) when creating a new article but after the article is approved, the Description field can only be edited by reviewers. For more information about editing the Description for existing articles, see Edit a Knowledge Base article.

Title

The title of an article should clearly describe what the article shows the reader. Avoid beginning the title with the word How. Since most articles provide procedural guidance, starting each title with How would make alphabetizing difficult and cluttered. For example, instead of How to change your New Tab background, use Change your New Tab background.

Title requeriments by article type

Different types of articles have specific requirements to ensure titles are clear and helpful for users.

  • How-to articles: Use action verbs to clearly indicate the task. Example: Change Your New Tab Background.
  • About articles: Focus on the concept or feature being explained. Example: Understand Firefox Extensions.
  • Troubleshooting articles: Describe the issue and include an action-oriented solution.
  • FAQ articles: Clearly state the topic or common question. Example: Mozilla VPN - FAQ.
New article - title

For specific writing guidelines for each article type, please see:

Slug

The slug is the link to the article. Keep it short. The slug for “Joining a Conversation” might become “joining-conversation.”

New article - slug

Category

Choose a category based on what this article is meant to do. Does this article show readers how to do something with a Firefox app? Choose How to. Does it help with a troubleshooting problem? Choose Troubleshooting.

New article - category

Relevant to

What is this article relevant to? Does it deal with Firefox? Firefox for iOS? Firefox for Android? Choose all that apply.

New article- relevant to

Topics

In Topics there are drop down menus. If your article is relevant to Firefox, click the Firefox dropdown menu. Then click which parts of Firefox the article applies to, such as Learn the Basics, Firefox Sync and Privacy and Security Settings. Choose all that apply.

New article - topics

Related documents

Most articles are related to other articles. Type in the beginning of the name of a related article. Kitsune will automatically find related articles that you can click.

Note: Adding related documents is currently disabled (Bug 1729134).

Keywords

Keywords can improve search results by adding terms that are not included in the article's Search result summary.

New article- keywords
Note: It is not in your best interest to overload your keyword field with as many relevant keywords as possible. Doing so will lower the amount of points awarded to your keyword, resulting in your article's search ranking diminishing. For more information, see this article.

Search result summary

The summary gives a glimpse of what the article is about to help the user decide if they’re in the right place. Provide a textual overview or definition of the concept and introduce the FAQ. Limit the summary to 140 characters, as search engines may cut off anything longer.

New article- search summary

Knowledge Base guidelines

More guidelines on Knowledge Base contribution can be found here.

Var den här artikeln till hjälp?

Vänligen vänta...

Dessa fina personer hjälpte till att skriva den här artikeln:

Illustration of hands

Bli volontär

Väx och dela din expertis med andra. Svara på frågor och förbättra vår kunskapsbas.

Läs mer