Feedback
|
Table Of Contents
Engineering/Release Operations
Reference Material for Writers and Editors
Documentation Resources
This appendix provides lists of useful websites and e-mail aliases to help writers and editors track, research, and write Cisco documentation. This appendix also contains a list of websites for information about Cisco style, templates, and so forth. In addition, there are process and procedure tips to help you work more efficiently.
This appendix includes the following sections:
•
Engineering/Release Operations
•
Reference Material for Writers and Editors
Documentation Groups
You can find the Cisco documentation groups at the Cisco Documentation Groups' internal home page at the following website:
http://wwwin.cisco.com/techdoc/
Note
There is also a link to the New Hire Information page from this site.
Cisco Connection Groups
You can find the Cisco.com groups at the following websites:
•
Cisco.com group home page
http://wwwin.cisco.com/webdev/internet/
•
Central Engineering Services documentation tools related to publishing (contains information about CCIM, doc bugs, and online help)
http://wwwin.cisco.com/techdoc/doctools/index.shtml
•
Central Publishing Services documentation resources related to illustrations and documentation production
http://wwwin.cisco.com/ios/spd/kmd/cps/dcr/tm.shtml
•
Documentation Schedule Database (DSD)
http://wwwin.cisco.com/cgi-bin/it/cdc/dsd/dsd_login.pl
•
Publishing Processes and Policies
http://wwwin.cisco.com/webdev/internet/adp/
E-Mail Aliases
You can use the following e-mail aliases to answer some of your documentation questions:
Visit http://www-mailer.cisco.com/mailer.html (Mailer home page) for more information about aliases.
Engineering/Release Operations
You can find engineering information at the following websites:
•
Central Engineering Services documentation tools related to publishing (contains information about CCIM, doc bugs, FrameMaker templates, and online help)
http://wwwin.cisco.com/techdoc/doctools/index.shtml
•
Cisco Software Release Operations
http://wwwin-release.cisco.com/relops/index/intro.shtml
•
IOS Software Release Operations
http://wwwin-release.cisco.com/relops/
•
Project Data System (IOS features)
http://wwwin-eit.cisco.com/pds/cf/
•
Release Operations TrainTracker
http://wwwin-rtim.cisco.com/traintracker/go?tab=home
•
Corporate Defect Tracking (DDTS) home page
http://wwwin.cisco.com/ios/cets/pdi/cbms/
•
Engineering@Cisco home page
http://wwwin-eng.cisco.com/Eng/CntlSvcs/InfoFrwk/GblEngWWW/Public/eng-home.htm
•
Engineering Document Control System (EDCS) (engineering specifications)
http://wwwin-eng.cisco.com/Eng/CntlSvcs/InfoFrwk/GblEngWWW/Public/gold-index.html
•
EDCS browser
http://wwwin-eng.cisco.com/Eng/CntlSvcs/InfoFrwk/GblEngWWW/EngRestricted/
eng-project-index.html•
Cisco IOS software image-naming conventions
http://wwwin-eng.cisco.com/Eng/Process/Release/image_naming
Documentation Part Numbers
Customer documents are assigned unique numbers that facilitate customer ordering, product kitting, and internal project tracking. Any customer document other than an embedded online help file requires a documentation part number.
Documentation part numbers are generated by the Cisco Document Control team and administered by means of the Document Schedule Database (DSD).
Note
For the most recent information about documentation part numbers, see the following websites:
•
Document Control team at http://wwwin.cisco.com/ios/spd/kmd/cps/documentcontrol/.
•
DSD at http://wwwin.cisco.com/cgi-bin/it/cdc/dsd/dsd_login.pl and click the Download DSD User Guide link.
Reference Material for Writers and Editors
As you work on Cisco documentation, you should find the following style, tool, and technical references to be helpful.
Topic Document TitleCisco style and tool references
•
Cisco Distribution Team home page and change-request form to submit changes to the style guide
http://wwwin.cisco.com/ios/spd/kmd/cps/dcr/templates/tmpl_req/
•
FrameMaker Templates Handbook and other template resources
Documentum Web Publisher (http://ecmx-wp.cisco.com/wp/), under Sites (Web Cabinets)/TD/docs/general/TD_FM_Templates
•
The Cisco Marketing Style Guide
•
Cisco Technical Documentation Style Guide (latest version of style guide)
http://preview.cisco.com/en/US/docs/general/style/guide/latest/sg.html
•
Guidelines for Writing Single-Sourced Cisco IOS Documentation
http://wwwin-eng.cisco.com/Workgroup/Mkt/IOS_Doc/Process/iwg.pdf
•
Command Reference Tagging Guidelines for the Cisco IOS Doc Set
http://wwwin-eng.cisco.com/Workgroup/Mkt/IOS_Doc/Process/Job_Guidelines_Aids/CRefTag.pdf
•
Task Table Tagging Guidelines for FrameMaker
http://wwwin-eng.cisco.com/Workgroup/Mkt/IOS_Doc/Process/Job_Guidelines_Aids/tasktag.pdf
•
Direct access to Cisco Technical Documentation
http://www.cisco.com/go/techdocs
Note
The above URL points to the Product Selector Application (PSA), where customers can find all Cisco technical documentation. Feel free to use this URL in prefaces, release notes, and other docs where you need to provide a general link to Cisco technical documentation.
Other style and tool references
•
The Chicago Manual of Style
•
IEEE Transactions, Journals, and Letters: Information for Authors (p. 4)
www.ieee.org/pubs/transactions/auinfo03.pdf
•
The Elements of Style
•
Language-tools references
http://www.itools.com/research-it/research-it.html
•
Merriam-Webster's Collegiate Dictionary
•
Microsoft Manual of Style for Technical Publications
•
Online writing resources
http://wwwin.cisco.com/ios/spd/kmd/cps/dcr/templates/tmpl_req/
•
Words into Type
Cisco technical references
•
Accessibility Initiative
http://wwwin.cisco.com/accessibility/
•
Cisco Industry Standards and Regulations Library
http://wwwin-tools.cisco.com/cse/stds/jsp/home.do
•
Cisco Legal Services
http://wwwin.cisco.com/legal/index.html
Contains information on corporate affairs, licensing and technology, intellectual property, regulatory affairs, privacy, and more.
•
Cisco trademarks
http://wwwin.cisco.com/techdoc/doctools/template/Trademarks.shtml
•
Networking Master Terminology List
http://wwwin.cisco.com/CustAdv/ts/learning/shared/epws/docs/PTK/REF-TL-NMTL.pdf
Other technical references
•
ATM Dictionary
http://www.cell-relay.com/cell-relay/FAQ/dictionary/dictionary.html
•
The Authoritative Dictionary of IEEE Standards Terms
•
Computer dictionaries and glossaries
http://www.carnegielibrary.org/subject/compinternet/dictionaries.html
•
IBM Dictionary of Computing
•
Microsoft Computer Dictionary
•
Newton's Telecom Dictionary (published annually)
•
Tom Sheldon's Linktionary.com
Feedback