DocWiki:Scope - Revision history

Pzimmerm: /* Out-of-Scope Content */ removed ref to SupportWiki, added new one about non-collaborative content

2009-10-19T19:12:30Z

Out-of-Scope Content: removed ref to SupportWiki, added new one about non-collaborative content

← Older revision		Revision as of 19:12, 19 October 2009
Line 33:		Line 33:
	*Detailed case studies.		*Detailed case studies.
	*Sales and marketing collateral.		*Sales and marketing collateral.
-	*~~Technical workarounds~~ or ~~fixes better suited~~ to ~~the [http://supportwiki.cisco.com Cisco Support Wiki]~~.	+	*Non-collaborative content, such as video or pages that contain only links to other sites.

	[[Category:DocWiki guidelines]]		[[Category:DocWiki guidelines]]

Willibro at 22:44, 4 February 2009

2009-02-04T22:44:06Z

← Older revision		Revision as of 22:44, 4 February 2009
Line 27:		Line 27:
	==Out-of-Scope Content==		==Out-of-Scope Content==

-	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:	+	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 [http://www.ciscopress.com Cisco Press] books.		*Detailed tutorial and application information that reproduces information found in [http://www.ciscopress.com Cisco Press] books.

Fenton: Apply DocWiki guidelines category

2008-12-05T22:45:44Z

Apply DocWiki guidelines category

← Older revision		Revision as of 22:45, 5 December 2008
Line 34:		Line 34:
	*Sales and marketing collateral.		*Sales and marketing collateral.
	*Technical workarounds or fixes better suited to the [http://supportwiki.cisco.com Cisco Support Wiki].		*Technical workarounds or fixes better suited to the [http://supportwiki.cisco.com Cisco Support Wiki].
		+
		+	[[Category:DocWiki guidelines]]

Pzimmerm at 22:12, 31 October 2008

2008-10-31T22:12:33Z

← Older revision		Revision as of 22:12, 31 October 2008
Line 7:		Line 7:
	DocWiki is currently in pilot, so the number of products and documents included here is very limited. This will change once DocWiki is in production.		DocWiki is currently in pilot, so the number of products and documents included here is very limited. This will change once DocWiki is in production.

-	~~h1.~~ In-Scope Content	+	==In-Scope Content==

	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:		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:
Line 25:		Line 25:
	*Comments and suggestions on how the Cisco documentation or other DocWiki contributions could be improved.		*Comments and suggestions on how the Cisco documentation or other DocWiki contributions could be improved.

-	~~h1.~~ Out-of-Scope Content	+	==Out-of-Scope Content==

	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:		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:

Pzimmerm: Added headers for ease of reading

2008-10-31T22:09:41Z

Added headers for ease of reading

← Older revision		Revision as of 22:09, 31 October 2008
Line 6:		Line 6:

	DocWiki is currently in pilot, so the number of products and documents included here is very limited. This will change once DocWiki is in production.		DocWiki is currently in pilot, so the number of products and documents included here is very limited. This will change once DocWiki is in production.
		+
		+	h1. In-Scope Content

	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:		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:
Line 22:		Line 24:
	*Content categories that do not already exist on DocWiki but make it easier for users to find content.		*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.		*Comments and suggestions on how the Cisco documentation or other DocWiki contributions could be improved.
		+
		+	h1. Out-of-Scope Content

	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:		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:

Fenton: correct dumb omission

2008-04-11T21:51:06Z

correct dumb omission

← Older revision		Revision as of 21:51, 11 April 2008
Line 29:		Line 29:
	*Detailed case studies.		*Detailed case studies.
	*Sales and marketing collateral.		*Sales and marketing collateral.
-	*Technical workarounds or fixes better suited to the [http://supportwiki.cisco.com Cisco Support Wiki.	+	*Technical workarounds or fixes better suited to the [http://supportwiki.cisco.com Cisco Support Wiki].

Fenton: Link to support wiki, few cleanups

2008-04-11T21:50:25Z

Link to support wiki, few cleanups

← Older revision		Revision as of 21:50, 11 April 2008
Line 1:		Line 1:
-	Any Cisco customer, ~~user~~ or employee is welcome to contribute to or change the content of this wiki.	+	Any Cisco customer, partner or employee with a cisco.com account 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:		To ensure that DocWiki remains useful and accurate, please try to restrict your contributions to:
Line 5:		Line 5:
	*Only the Cisco product documentation posted 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.)	+	DocWiki is currently in pilot, so the number of products and documents included here 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:		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:
Line 29:		Line 29:
	*Detailed 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}~~.	+	*Technical workarounds or fixes better suited to the [http://supportwiki.cisco.com Cisco Support Wiki.

Willibro at 20:24, 11 April 2008

2008-04-11T20:24:23Z

← Older revision		Revision as of 20:24, 11 April 2008
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~~.	+

Mguthrie at 16:15, 7 February 2008

2008-02-07T16:15:18Z

← Older revision		Revision as of 16:15, 7 February 2008
Line 1:		Line 1:
-	The scope of DocWiki is specifically limited to technical documentation — "manuals" — describing Cisco products. As a general rule, if the information being added would be appropriate in Cisco technical documentation, it's appropriate for DocWiki.	+	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.

	==Within scope==		==Within scope==
Line 19:		Line 19:
	*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		*Case studies
-	*Sales collateral	+	*Sales and marketing collateral

	and similar information.		and similar information.

Fenton: Initial version

2008-02-05T05:22:05Z

Initial version

New page

The scope of DocWiki is specifically limited to technical documentation — "manuals" — describing Cisco products. As a general rule, if the information being added would be appropriate in Cisco technical documentation, it's appropriate for DocWiki.

==Within scope==

Anything that would be found in a typical printed Cisco manual is appropriate for DocWiki. This includes:

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

and similar documentation.

==Out of scope==

DocWiki is not intended to be a general-purpose wiki with information on Cisco products. The following would be considered out of scope:

*Tutorial and application information, such as that found in [http://www.ciscopress.com Cisco Press] books
*Information that would identify a specific customer's use of Cisco products
*Case studies
*Sales collateral

and similar information.