DocWiki:About

From DocWiki

Revision as of 20:53, 17 January 2008 by Fenton (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.

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 on this. Eventually, we expect to label specific page revisions as "official", that they have been reviewed by Cisco Documentation Editors and are believed to be correct.

DocWiki is based on the MediaWiki software platform, and as such 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; you are encouraged to become familiar with these.

Philosophy

In order to be a credible source of documentation which serves, involves, and inspires the extended Cisco technical community, DocWiki must be viewed as a forum for honest and open exchange of useful information about the use of Cisco products. Towards that end, the information must be accurate, precise, and have a minimal perceived bias towards Cisco and Cisco products.

The forum must be viewed as a safe place to exchange ideas.

The participation of the broader community of contributors must produce a documentation set more rich and complete that one produced only through the current documentation process.

Though the wiki may be segregated into parts, the wiki should seek to be a single, cohesive source. For example, one proposed segregation of the wiki might be that a portion of the wiki may mirror the canonical, traditionally produced documentation and another portion can be exclusively for community content. While this may be expedient for internal goals, it does go against the spirit and intent of a wiki space.

Access Control

Read access to DocWiki is public and does not require a 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 get more experience with managing the wiki.

Personal tools