DocWiki:About

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Policies and Guidelines)
 
(43 intermediate revisions not shown)
Line 1: Line 1:
-
Welcome to '''Cisco DocWiki'''.  Please feel free to contribute.
+
Welcome to '''Cisco DocWiki'''.   
 +
This wiki lets Cisco users, customers, partners and employees improve Cisco product documentation by contributing their own suggestions, corrections, and new information directly.
 +
Feel free to contribute!
-
You can read anything on DocWiki without logging in. If you want to contribute, you'll need to login using your Cisco.com account. If you do not already have a Cisco.com account, [http://tools.cisco.com/RPF/register/register.do please register before continuing.]
+
==Reading==
 +
Cisco DocWiki is public. Anyone may read or rate articles on DocWiki, without logging in. You can also use the history tab to see what changes have been made from a previous revision.
-
==Goals==
+
==Contributing==
-
+
If you want to comment on or contribute to Cisco DocWiki, you must first log in. To get login credentials, you must [http://tools.cisco.com/RPF/register/register.do register with Cisco.com]. Note that you cannot log in to DocWiki with Cisco.com "guest" account credentials.
-
DocWiki is an experiment in next-generation documentation for [http://cisco.com Cisco] products. DocWiki seeks to empower our users to directly improve our documentation rather than relying on filing bug reports when they notice an error. In addition, DocWiki allows users to enhance documentation by contributing information and experience-based knowledge.  
+
-
The result, we hope, is that DocWiki will result in an overall improvement to the quality and completeness of our documentation by making community-provided changes immediately available to DocWiki users. For the time being, our traditional documentation will remain the official source for information regarding product functionality for warranty purposes and the like. See our [[DocWiki:General_disclaimer|Terms of Use]] for more information about this. Eventually, we expect to label specific page revisions as "official," indicating that they have been reviewed by Cisco documentation editors and are believed to be correct.
+
All contributors accept the DocWiki [[DocWiki:General_disclaimer|Terms of Use]]. All contributors must observe the DocWiki Policies and Guidelines listed below.  
-
DocWiki is based on the [http://www.mediawiki.org/ MediaWiki] software platform. It shares a common markup language with many other wikis, including Wikipedia. However, the [[DocWiki:About#Policies and Guidelines|policies and guidelines]] used by DocWiki differ significantly from Wikipedia in some areas. Please become familiar with these.
+
DocWiki is based on the MediaWiki software platform. Many other wikis, such as Wikipedia, use the same software. If you are new to the MediaWiki platform and need help using it, see the [http://www.mediawiki.org/wiki/Help:Contents MediaWiki Documentation]. DocWiki also provides the ability to rate articles and to Leave a Comment. In addition, [http://www.mediawikiwidgets.org/Iframe iFrames] can be used to display content on DocWiki pages from other externally published sources.  
-
==Philosophy==
+
For basic editing, see also the "cheat sheet" at [[Cisco Unified MeetingPlace, Release 6.x -- How to Use This Wiki for Cisco Unified MeetingPlace Information|How to Use This Wiki for Cisco Unified MeetingPlace Information]].  This content was developed for the Cisco Unified MeetingPlace content, but much of it is applicable to any content on this wiki.
-
In order to be a credible source of documentation that serves, involves, and inspires the extended Cisco technical community, DocWiki should be viewed and treated as a forum for honest and open exchange of useful information about the use of Cisco products. Toward that end, the information must be accurate, precise, and have a minimal perceived bias toward Cisco and Cisco products.
+
==Policies and Guidelines==
-
The forum should be viewed and treated as a safe place to exchange ideas.  
+
DocWiki content is intended to be complete, accurate, useful, and safe. To help ensure that your contributions meet these standards, please observe the following policies and guidelines:
-
The participation of the broader community of contributors should produce a documentation set more rich and complete than one produced only through the current documentation process.  
+
# [[DocWiki:Style|Style]] describes the style guidelines for content on DocWiki.
-
 
+
# [[DocWiki:Scope|Scope]] summarizes the types of content and contributions that are appropriate for inclusion on DocWiki.
-
==Access==
+
# [[DocWiki:Etiquette|Etiquette]] explains what Cisco considers acceptable comments and content contributions.   
-
 
+
# [[DocWiki:Categories|Categories]] describes the guidelines for creating categories for your content.
-
Read access to DocWiki is public and does not require a login; creation and editing of content requires login.  Registered users of cisco.com that are Cisco customers, partners, and employees can log in to DocWiki using their cisco.com credentialsCurrently, users with guest accounts on cisco.com may not log in to DocWiki; that rule may be liberalized as we gain more experience managing the wiki.
+
# [[DocWiki:No Promotion|No Promotion]] details the requirement that DocWiki not be used to promote products or services, Cisco's or otherwise.
-
 
+
# [[DocWiki:No Proprietary Information|No Proprietary Information]] describes the requirements that DocWiki contain only public information and sanitized examples.
-
==Policies and Guidelines==
+
# [[DocWiki:Vulnerabilities|Vulnerabilities]] outlines DocWiki policies with respect to publishing information about product security vulnerabilities.
 +
# [[DocWiki:Content Arbitration|Content Arbitration]] describes the method for resolving content disputes.
-
DocWiki content is intended to be comparable in content and accuracy to traditional Cisco documentation.
+
Cisco reserves the right to alter or delete contributions that do not respect these policies and guidelines. Contributors who violate them consistently may be banned from further contribution.
-
Policies and guidelines can be found at:
+
==Feedback==
-
# [[DocWiki:Article Titling]] describes the style and format for article titles, to help users find articles and avoid collisions between article names.
+
We welcome your comments and constructive criticisms about DocWiki. Please address them to [mailto:docwiki-support@cisco.com docwiki-support@cisco.com].
-
# [[DocWiki:Content Arbitration]] describes the method for resolving content disputes.
+
-
# [[DocWiki:No Promotion]] details the requirement that DocWiki not be used to promote products or services, Cisco's or otherwise.
+
-
# [[DocWiki:No Proprietary Information]] describes the requirements that DocWiki contain only public information, and for sanitization of examples.
+
-
# [[DocWiki:Scope]] summarizes the types of content that are appropriate for inclusion on DocWiki.
+
-
# [[DocWiki:Style]] describes the style and formatting guidelines for content on DocWiki
+
-
# [[DocWiki:Vulnerabilities]] outlines the policies with respect to publishing information on product security vulnerabilities.
+

Latest revision as of 17:23, 13 February 2012

Welcome to Cisco DocWiki. This wiki lets Cisco users, customers, partners and employees improve Cisco product documentation by contributing their own suggestions, corrections, and new information directly. Feel free to contribute!

Contents

Reading

Cisco DocWiki is public. Anyone may read or rate articles on DocWiki, without logging in. You can also use the history tab to see what changes have been made from a previous revision.

Contributing

If you want to comment on or contribute to Cisco DocWiki, you must first log in. To get login credentials, you must register with Cisco.com. Note that you cannot log in to DocWiki with Cisco.com "guest" account credentials.

All contributors accept the DocWiki Terms of Use. All contributors must observe the DocWiki Policies and Guidelines listed below.

DocWiki is based on the MediaWiki software platform. Many other wikis, such as Wikipedia, use the same software. If you are new to the MediaWiki platform and need help using it, see the MediaWiki Documentation. DocWiki also provides the ability to rate articles and to Leave a Comment. In addition, iFrames can be used to display content on DocWiki pages from other externally published sources.

For basic editing, see also the "cheat sheet" at How to Use This Wiki for Cisco Unified MeetingPlace Information. This content was developed for the Cisco Unified MeetingPlace content, but much of it is applicable to any content on this wiki.

Policies and Guidelines

DocWiki content is intended to be complete, accurate, useful, and safe. To help ensure that your contributions meet these standards, please observe the following policies and guidelines:

  1. Style describes the style guidelines for content on DocWiki.
  2. Scope summarizes the types of content and contributions that are appropriate for inclusion on DocWiki.
  3. Etiquette explains what Cisco considers acceptable comments and content contributions.
  4. Categories describes the guidelines for creating categories for your content.
  5. No Promotion details the requirement that DocWiki not be used to promote products or services, Cisco's or otherwise.
  6. No Proprietary Information describes the requirements that DocWiki contain only public information and sanitized examples.
  7. Vulnerabilities outlines DocWiki policies with respect to publishing information about product security vulnerabilities.
  8. Content Arbitration describes the method for resolving content disputes.

Cisco reserves the right to alter or delete contributions that do not respect these policies and guidelines. Contributors who violate them consistently may be banned from further contribution.

Feedback

We welcome your comments and constructive criticisms about DocWiki. Please address them to docwiki-support@cisco.com.

Personal tools