DocWiki:Categories

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Added Categories section)
 
(9 intermediate revisions not shown)
Line 1: Line 1:
-
* Users should tag articles with all appropriate categories (products, technologies, software releases, tasks). This will allow readers to access content through multiple paths.
+
==Adding Your Categories to the Topic Map==
 +
In MediaWiki, you make your category part of a topic map by making it subcategory of that topic.
 +
:Put the desired category in your article, using the guidelines below:
-
* When tagging your content, create a subcategory under the main category. This structure allows readers to find content by main topic.
+
  <nowiki>[[Category:example]]</nowiki>
 +
 
 +
:After saving the category, go to the newly created category and make it a subcategory of Cisco Product, System, or Technology:
 +
 
 +
<nowiki>  [[Category:Cisco Products]]</nowiki>
 +
 
 +
You can create a nesting of categories on DocWiki. See the flowchart below for the suggested organziation of categories on DocWiki.
 +
 
 +
==Category Organization==
 +
 
 +
Categories on DocWiki are organized by topics.  The following flowchart shows the organization.
 +
 
 +
[[Image:categories.jpg]]
 +
 
 +
==Guidelines==
 +
 
 +
Please follow these guidelines for DocWiki categories:
 +
 
 +
*Users should tag articles with all appropriate categories (Cisco Products, Technologies). This will allow readers to access content through multiple paths.  
* In general, categories should be as specific as possible. However, sometimes a general category is a better choice than a specific category, depending on the content. Use your discretion.
* In general, categories should be as specific as possible. However, sometimes a general category is a better choice than a specific category, depending on the content. Use your discretion.
-
* You don't have to categorize every page. Only main navigation pages need to be tagged.  
+
*Where applicable, categories should match the name of the lowest applicable level of MDF. If the content here will someday be tied to SupportWiki or Cisco.com, consistent terminology will be important.
 +
 
 +
*All pages should be marked with a category.
 +
 
 +
*Categories should include more than one article.
 +
 
 +
*Do not include "Cisco" in product names for categories. This will cause all products to appear under "C", which defeats the purpose of indexing. However, "Cisco" must be part of the product names in the actual articles. This guideline only applies to categories. 
 +
 
 +
*The Governance team will review the categories from time to time to see what is being used and to ensure that the categories follow the guidelines.
 +
 
 +
See the [http://meta.wikimedia.org/wiki/Help:Category MediaWiki help on Categories] for more information.
 +
 
 +
==Naming Conventions==
-
* Categories should include more than one article.  
+
DocWiki encourages the use of the [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(categories) Wikipedia category naming conventions].
-
* Do not include "Cisco" in product names for categories. This will cause all products to appear under "C", which defeats the purpose of indexing. The Cisco Products main category has "Cisco" in the name, so the subcategories underneath it are understood to be Cisco products. However, you should include "Cisco" with the appropriate product names in your articles.
+
[[Category:DocWiki guidelines]]

Latest revision as of 13:19, 19 May 2011

Contents

Adding Your Categories to the Topic Map

In MediaWiki, you make your category part of a topic map by making it subcategory of that topic.

Put the desired category in your article, using the guidelines below:
  [[Category:example]]
After saving the category, go to the newly created category and make it a subcategory of Cisco Product, System, or Technology:
  [[Category:Cisco Products]]

You can create a nesting of categories on DocWiki. See the flowchart below for the suggested organziation of categories on DocWiki.

Category Organization

Categories on DocWiki are organized by topics. The following flowchart shows the organization.

Categories.jpg

Guidelines

Please follow these guidelines for DocWiki categories:

  • Users should tag articles with all appropriate categories (Cisco Products, Technologies). This will allow readers to access content through multiple paths.
  • In general, categories should be as specific as possible. However, sometimes a general category is a better choice than a specific category, depending on the content. Use your discretion.
  • Where applicable, categories should match the name of the lowest applicable level of MDF. If the content here will someday be tied to SupportWiki or Cisco.com, consistent terminology will be important.
  • All pages should be marked with a category.
  • Categories should include more than one article.
  • Do not include "Cisco" in product names for categories. This will cause all products to appear under "C", which defeats the purpose of indexing. However, "Cisco" must be part of the product names in the actual articles. This guideline only applies to categories.
  • The Governance team will review the categories from time to time to see what is being used and to ensure that the categories follow the guidelines.

See the MediaWiki help on Categories for more information.

Naming Conventions

DocWiki encourages the use of the Wikipedia category naming conventions.

Personal tools