DocWiki:About

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(top-section cleanup; added Goals section, etc.)
(Policies and Guidelines)
Line 29: Line 29:
Policies and guidelines can be found at:
Policies and guidelines can be found at:
-
# [[DocWiki:Scope]] summarizes the types of content that are appropriate for inclusion on DocWiki.
 
-
# [[DocWiki:No Proprietary Information]] describes the requirements that DocWiki contain only public information, and for sanitization of examples.
 
# [[DocWiki:Article Titling]] describes the style and format for article titles, to help users find articles and avoid collisions between article names.
# [[DocWiki:Article Titling]] describes the style and format for article titles, to help users find articles and avoid collisions between article names.
-
# [[DocWiki:Vulnerabilities]] outlines the policies with respect to publishing information on product security vulnerabilities.
+
# [[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 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: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.

Revision as of 21:38, 5 February 2008

Welcome to Cisco DocWiki. Please 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, please register before continuing.

Contents

Goals

DocWiki is an experiment in next-generation documentation for 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 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.

DocWiki is based on the MediaWiki software platform. It shares a common markup language with many other wikis, including Wikipedia. However, the policies and guidelines used by DocWiki differ significantly from Wikipedia in some areas. Please become familiar with these.

Philosophy

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.

The forum should be viewed and treated as a safe place to exchange ideas.

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.

Access

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 credentials. Currently, 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.

Policies and Guidelines

DocWiki content is intended to be comparable in content and accuracy to traditional Cisco documentation.

Policies and guidelines can be found at:

  1. DocWiki:Article Titling describes the style and format for article titles, to help users find articles and avoid collisions between article names.
  2. DocWiki:Content Arbitration describes the method for resolving content disputes.
  3. DocWiki:No Promotion details the requirement that DocWiki not be used to promote products or services, Cisco's or otherwise.
  4. DocWiki:No Proprietary Information describes the requirements that DocWiki contain only public information, and for sanitization of examples.
  5. DocWiki:Scope summarizes the types of content that are appropriate for inclusion on DocWiki.
  6. DocWiki:Style describes the style and formatting guidelines for content on DocWiki
  7. DocWiki:Vulnerabilities outlines the policies with respect to publishing information on product security vulnerabilities.
Personal tools