Cisco Support Community
cancel
Showing results for 
Search instead for 
Did you mean: 

Configuration Example Document Template

NOTE: Check out

How to Format Your Document from a Templatefor the HTML CODE to copy

 

 

 

 

General Guidelines for Document creation
  • Title of the document: Be specific while giving the Title for the Document. Example

Bad: "Route-tracking feature"

Good: "Configuration and Troubleshooting Route-Tracking feature on FWSM"

  • Make sure that the configurations, screen shots, etc. you use in the document do not contain any confidential or your customer-related information
  • Use the product names in the document in a consistent fashion. Say for example, if you are creating a document on Cisco Unified Communications Manager, Use the same name throughout the document, don’t use Cisco Call manager anywhere in the document.
  • Include the IP addresses in the network diagram for easy reference.
  • The people who read these documents are people who have a problem and need a solution. With that in mind, keep the document as short as possible. Make sure that your document addresses the problem and provides a solution.
  • Do the Spell check before submitting the document.

 

Note: General Guidelines are only for Information. Make sure to delete this section before publishing the Document.

Introduction

 

This document provides a sample configuration for ... (this introduction should provide a description of the subject matter and any contextual information describing a real-world scenario in which this information might be used).

 

Prerequisites

Requirements

There are no specific requirements for this document.

OR

Ensure that you meet these requirements before you attempt this configuration:

 

Example:

Cisco recommends that you have knowledge of these topics:

  • Cisco Unified Communications Manager 7.x
  • Cisco Unified Communications Manager 8.x

Components Used

This section includes information on the hardware, software, and Cisco IOS® version that was used.

 

Example :

Cisco CallManager versions 7.x and 8.x, Cisco IP Phones 7970

 

Configuration

Please provide sample configuration relevant to the document.

  • Include the sample Configuration steps using CLI / GUI Screenshots whichever is applicable.
  • Make sure to use Generic device names, hostnames, usernames, and passwords.Important: Do not use confidentional username or password in your configurations which may cause security-risk.
  • Here is an existing sample configuration example for your reference:

Sample document example 1

Sample document example 2

Network Diagram

Please provide the network diagram to explain.

  • Include the Network Diagram with the Product Name, IP address. Use the Product name in a Consistent fashion throughout the document.
  • Use Standard Product Icons on the Network Diagram.

Verify

You can use this section to confirm that your configuration works properly. For verify sections, include Show commands and Sample outputs.

Related Information

  • Link 1
  • Link 2

Note:

  • Please provide the relevant Document/Tools link for Reference. Say for example, if you have taken any Product Installation/Configuration Guide as reference for creating this document then you can provide the same link in this section.
  • When you are referring any Tool/link which requires CCO login then Pl mention the same.
Version history
Revision #:
2 of 2
Last update:
‎08-29-2017 09:12 AM
Updated by:
 
Labels (1)
Contributors
Everyone's tags (1)