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.
Table of Contents
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.
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 Firefox app? Choose
. Does it help with a troubleshooting problem? Choose .Relevant to
What is this article relevant to? Does it deal with Firefox? Firefox for iOS? Firefox for Android? Choose all that apply.
Topics
In
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 , and . Choose all that apply.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.
Knowledge Base guidelines
More guidelines on Knowledge Base contribution can be found here.