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

Tech Note or "How To" 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 Troubleshooting / Tech notes 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).

 

Problem Description

In this section describe the symptoms of the problem and the main issue the document resolves. A clear description of the problem, including any relevant information about affected hardware and/or software versions.

 

Background Information (optional)

In this section please provide the Topology and the Information relevant to the Problem.

 

Solution

In this section please provide the answer or resolution to the problem provided in the "Problem Description" section.

 

  • Step-by-step instructions using CLI / GUI Screenshots on how to find and fix the problem.
  • Troubleshooting steps shall include debug / show command outputs whichever applicable.
  • Debug commands should include disclaimer about impact, or use in lab environment only.

“The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command”.

  • Here is an existing sample Troubleshooting example for your reference:

Sample document example 1

Sample document example 2

 

 

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:04 AM
Updated by:
 
Labels (1)
Contributors
Everyone's tags (1)