DocWiki:Scope

From DocWiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
The scope of DocWiki is specifically limited to technical documentation — "manuals," "guides," or other document types— describing Cisco products.  As a general rule, if the information being added would be appropriate in Cisco technical documentation, it's appropriate for DocWiki.
+
Any Cisco customer, user or employee is welcome to contribute to or change the content of this wiki.  
-
==Within scope==
+
To ensure that DocWiki remains useful and accurate, please try to restrict your contributions to:
 +
*Only the Cisco products covered here. 
 +
*Only the Cisco product documentation posted here.
-
Anything that would be found in a typical printed Cisco manual is appropriate for DocWiki. This includes:
+
(DocWiki is currently in pilot, so the number of products and documents is very limited. This will change once DocWiki is in production.)
 +
As a general rule, if the information you are adding would be found in a typical printed Cisco manual, it is appropriate for DocWiki. This includes the kind of information found in Cisco:
*Command reference manuals
*Command reference manuals
*Installation and maintenance manuals
*Installation and maintenance manuals
Line 10: Line 13:
*Release notes
*Release notes
-
and similar documentation.
+
In addition to these kinds of content, we encourage you to contribute:
-
==Out of scope==
+
*Original articles that expand on or supplement Cisco product documentation.
 +
*Examples of any kind (such as configurations, implementation checklists, etc.).
 +
*Corrections to errors you find in the Cisco manuals.
 +
*Clarifications (or requests for clarification) of ambiguous content in Cisco manuals.
 +
*Links to offsite articles that amplify the information found on DocWiki.
 +
*Content categories that do not already exist on DocWiki but make it easier for users to find content.
 +
*Comments and suggestions on how the Cisco documentation or other DocWiki contributions could be improved.
-
DocWiki is not intended to be a general-purpose wiki with information on Cisco products. The following would be considered out of scope:
+
Please note that this is not a general-purpose wiki containing any kind of information about any topic. Please confine your efforts to the kinds of contributions listed above. Other contributions '''may''' be considered out-of-scope. DocWiki administrators and content stewards have wide discretion in determining whether a given contribution is out of scope, and may edit, move, recategorize, or (in rare cases) delete it. The following kinds of contributions would be considered out of scope:
-
*Tutorial and application information, such as that found in [http://www.ciscopress.com Cisco Press] books
+
*Detailed tutorial and application information that reproduces information found in [http://www.ciscopress.com Cisco Press] books.
-
*Information that would identify a specific customer's use of Cisco products
+
*Information that would identify a specific customer's use of Cisco products.
-
*Case studies
+
*Detailed case studies.
-
*Sales and marketing collateral
+
*Sales and marketing collateral.
-
 
+
*Technical workarounds or fixes better suited to the Support wiki {give link}.
-
and similar information.
+

Revision as of 20:24, 11 April 2008

Any Cisco customer, user or employee is welcome to contribute to or change the content of this wiki.

To ensure that DocWiki remains useful and accurate, please try to restrict your contributions to:

  • Only the Cisco products covered here.
  • Only the Cisco product documentation posted here.

(DocWiki is currently in pilot, so the number of products and documents is very limited. This will change once DocWiki is in production.)

As a general rule, if the information you are adding would be found in a typical printed Cisco manual, it is appropriate for DocWiki. This includes the kind of information found in Cisco:

  • Command reference manuals
  • Installation and maintenance manuals
  • Design guides
  • Release notes

In addition to these kinds of content, we encourage you to contribute:

  • Original articles that expand on or supplement Cisco product documentation.
  • Examples of any kind (such as configurations, implementation checklists, etc.).
  • Corrections to errors you find in the Cisco manuals.
  • Clarifications (or requests for clarification) of ambiguous content in Cisco manuals.
  • Links to offsite articles that amplify the information found on DocWiki.
  • Content categories that do not already exist on DocWiki but make it easier for users to find content.
  • Comments and suggestions on how the Cisco documentation or other DocWiki contributions could be improved.

Please note that this is not a general-purpose wiki containing any kind of information about any topic. Please confine your efforts to the kinds of contributions listed above. Other contributions may be considered out-of-scope. DocWiki administrators and content stewards have wide discretion in determining whether a given contribution is out of scope, and may edit, move, recategorize, or (in rare cases) delete it. The following kinds of contributions would be considered out of scope:

  • Detailed tutorial and application information that reproduces information found in Cisco Press books.
  • Information that would identify a specific customer's use of Cisco products.
  • Detailed case studies.
  • Sales and marketing collateral.
  • Technical workarounds or fixes better suited to the Support wiki {give link}.
Personal tools