DocWiki:Categories

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m
(Updated Category Info for CategoryTrees)
Line 8: Line 8:
    
    
  <nowiki>  [[Category:Task]]</nowiki>
  <nowiki>  [[Category:Task]]</nowiki>
 +
 +
==Category Organization==
 +
 +
Categories on DocWiki are organized by topics.  The following flowchart shows the organization.
 +
 +
[[Image:categories.jpg]]
==Guidelines==
==Guidelines==
-
* Users should tag articles with all appropriate categories (Cisco Product, Software, Task, Technology). This will allow readers to access content through multiple paths.
+
Please follow these guidelines for DocWiki categories:
-
* When tagging your content, create a subcategory under the main category. This structure allows readers to find content by main topic.
+
*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.
-
* Categories should include more than one article.  
+
*There are [http://docwiki.cisco.com/wiki/Special:UnusedCategories|special pages] that show category usage, and the Governance team can review those from time to time to see what is being used and to ensure that the categories follow the guidelines.
-
* 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.
+
See the [http://meta.wikimedia.org/wiki/Help:Category MediaWiki help on Categories] for more information.
[[Category:Category Guidelines]]
[[Category:Category Guidelines]]

Revision as of 06:49, 18 November 2008

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, Software, Task, or Technology:
  [[Category:Task]]

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.
  • There are pages that show category usage, and the Governance team can review those 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.

Personal tools