Sammenlign revisioner

Article Description

Revision 262285:

Revision 262285 af AliceWyman den

Revision 283068:

Revision 283068 af lsiebert den

Nøgleord:

Sammendrag til søgeresultat:

Fill out an article description before writing an article.
Fill out an article description before writing an article.

Indhold:

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}'''Note:''' All contributors can include a description (title, category, relevant product, etc.) when [[Create a new Knowledge Base article|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#w_edit-description-reviewers-only]].{/note} # 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? Choose all that apply. #;[[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} and {button Privacy and Security Settings}. Choose 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. {note}'''Note:''' Adding related documents is currently disabled ([https://bugzilla.mozilla.org/show_bug.cgi?id=1729134 bug 1729134]).{/note} #;[[Image:Related]]{warning}'''Warning:''' You should refrain from adding related documents in new articles that will be pending review. This will result in existing articles linking to unapproved articles because the links are reciprocal.{/warning} # Add keywords. Keywords can improve search results by adding terms that are not included in the article's Search result summary. #;[[Image:Keywords]] {note}'''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 [[When and how to use keywords to improve an article's search ranking|this article]].{/note} # In search result summary, type in a sentence or two that explains what the article is about. Try to include keywords in those sentences. This helps search engines find the article. #;[[Image:SearchResultsSummary]] = Knowledge Base guidelines = To see more guidelines on Knowledge Base contribution, click [https://support.mozilla.org/en-US/products/contributor/kb here].
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}'''Note:''' All contributors can include a description (title, category, relevant product, etc.) when [[Create a new Knowledge Base article|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#w_edit-description-reviewers-only]].{/note} __TOC__ =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''. ;[[Image:New article - title]] For specific writing guidelines for each article type, please see: *[https://support.mozilla.org/en-US/kb/how-to-article-type-best-practices "How-to" article type best practices] *[https://support.mozilla.org/en-US/kb/about-article-type-best-practices "About" article type best practices] *[https://support.mozilla.org/en-US/kb/troubleshooting-article-type-best-practices "Troubleshooting" article type best practices] *[https://support.mozilla.org/en-US/kb/faq-article-type-best-practices "FAQ" article type best practices] <!-- for some reason the wikilinks were not working on Kitsune - using regular links for now - please recheck this on future updates --> =Slug= The slug is the link to the article. Keep it short. The slug for “Joining a Conversation” might become “joining-conversation.” ;[[Image: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 {button How to}. Does it help with a troubleshooting problem? Choose {button Troubleshooting}. ;[[Image: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. ;[[Image:New article- relevant to]] =Topics= 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} and {button Privacy and Security Settings}. Choose all that apply. ;[[Image:New article - topics]] =<s>Related documents</s>= <s>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.</s> {warning}'''Note:''' Adding related documents is currently disabled ([https://bugzilla.mozilla.org/show_bug.cgi?id=1729134 Bug 1729134]).{/warning} =Keywords= Keywords can improve search results by adding terms that are not included in the article's Search result summary. ;[[Image:New article- keywords]] {note}'''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 [[When and how to use keywords to improve an article's search ranking|this article]].{/note} =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. ;[[Image:New article- search summary]] =Knowledge Base guidelines= To see more guidelines on Knowledge Base contribution, click [https://support.mozilla.org/en-US/products/contributor/kb here].

Tilbage til historik