Compare Revisions

Writing Articles

Fill out an article description before writing an article.

Before contributors can write the text for a new article, they must fill out the description. By categorizing an article like this, readers can find the article more easily. Here is how to do this. # The title should describe what the article shows the reader. Do not begin the title with the word “How.” Most articles show readers how to do something. If all procedural articles began with “How,” it would be difficult to alphabetize articles. Try “Joining a Conversation” rather than “How to Join a Conversation.” [[Image:Title]] # The slug is the link to the article. Keep it short. The slug for “Joining a Conversation” might become “joining-conversation.” [[Image:Slugline]] # 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 {button How to}. Does it help with a troubleshooting problem? Choose {button Troubleshooting}. [[Image:Category]] # What is this article relevant to? Does it deal with Firefox, Firefox for iOS, Firefox for Android, etc? Choose as many categories as you need. [[Image:Relevant]] # In {button 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 {button Learn the Basics}, {button Firefox Sync}, {button Privacy and Security Settings}, etc. Click all that apply. [[Image:Categories]] [[Image:Categories2]] # Most articles are related to other articles. Type in the beginning of the name of a related article. The computer will automatically find related articles that you can click. Add all related articles that apply. [[Image:Related]]{warning}'''Warning:''' refrain from searching for related documents to embed in your new article. This will result in existing articles linking to unapproved articles, because the links are reciprocal.{/warning} # Add keywords. For example, in an article about joining a conversation in Firefox Hello, you might type in Firefox Hello and Video Chat. [[Image:Keywords]]{note}'''Note:''' if a reader's search term matches one of your keywords, that word will be awarded a certain amount of points (which have preset maximums). The article with the highest number of points awarded to each keyword in its field will be displayed at the top of the search results page. However, it is '''not''' in your best interest to overload your keyword field with as many relevant words 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 about keywords, refer to [https://support.mozilla.org/en-US/kb/when-and-how-to-use-keywords this article].{/note} # In search results summary, type in a sentence or two that explains what the article shows. Try to include keywords in those sentences. This helps search engines find the article. [[Image:SearchResultsSummary]] For more information on writing articles, click [https://support.mozilla.org/en-US/kb/how-to-write-knowledge-base-articles here]. {note}After reading this article, please fill out this quick [https://docs.google.com/forms/d/1sk1KMZlsUTD6XYl0IVHEpzWOW-FwB8qgZRV0jIfIUlA/viewform form].{/note}