Përditësuar së fundi:
2 ditë më parë
This guide explains how to complete the article description (also called article metadata) when you create a new Knowledge Base article, as well as how KB reviewers can update this information after your submission is approved.
Table of Contents
Article metadata
Artile metadata is a set of information that helps categorize the article so readers can find it more easily.
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. More about how to choose an article title here.
Title requirements 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.
For specific writing guidelines for each article type, please see:
- "How-to" article type best practices
- "About" article type best practices
- "Troubleshooting" article type best practices
- "FAQ" article type best practices
Slug
The slug is the link to the article. Keep it short. The slug for “Joining a Conversation” might become “joining-conversation.”
Category
Choose a category based on what this article is meant to do. Does this article show readers how to do something with a Mozilla product? Choose . Does it help with a troubleshooting problem? Choose .
Allow translations
Check this option to allow the article to be translated. This setting is enabled by default.
Product(s)
What is this article relevant to? Does it relate to Firefox, Firefox for Android, or Firefox for iOS? Select all that apply.
Your product selection will determine the available topic options. For example, if you select Firefox, you won’t be able to choose topics that are specific to Thunderbird.
Topics
Available topic options depend on your selected product. Choose the most specific topic that applies to the article. For example, if the article is about bookmarks, select Bookmarks. The parent topic (in this case, Browse) will be selected automatically.
You may select multiple topics if applicable.
Allow discussion on this article?
Check this option to allow article discussion. This setting is enabled by default.
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.
Keywords
Keywords can improve search results by adding terms that are not included in the article's Search result summary.
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.
How to edit article metadata (reviewers only)
After a Knowledge Base article submission is approved, only reviewers can update its metadata. If you have reviewer permissions, you can access this by clicking the button under Editing Tools to open the Edit Article Metadata page. Make sure you are signed in to Mozilla Support before proceeding.
This is where you can:
- Change an article's title, slug, category, product and topics.
- Archive or un-archive an article (Controlled by the Obsolete: checkbox).
- Allow or disable article discussion (Allow discussion on this article? checkbox).
- Add or remove a Needs change: entry or comment.
- Change Related documents: entries.
After making your changes, click ; otherwise, your changes will not be saved.
More information
- For help writing articles, see Writing guide for Knowledge Base articles.
- To learn how to create a new article, see Create a new Knowledge Base article.
- To submit a minor update, see Submit a minor update in a Knowledge Base article.
- For reviewer guidelines, see Article review guidelines for KB reviewers.
More guidelines on Knowledge Base contribution can be found here.
