Usar Convenções de Formato para Dicas Técnicas e Outro Conteúdo

Introduction

Este documento descreve os formatos de texto, imagem e convenções de comando usados em dicas técnicas e conteúdo da Cisco.

Convenções gerais

As convenções gerais devem ser respeitadas para:

• Texto
• Alertas e ícones
• Comandos do software Cisco IOS®
• Exemplos de configuração
• Endereços IP (tenha cuidado aqui.)
• Comentários em blocos de código

Texto

• Negrito indica texto que o usuário deve inserir ou selecionar, como itens de menu, botões e comandos.

• Itálico indica ênfase.

• O sinal de maior ( >) indica a progressão das opções de menu que o usuário deve selecionar em uma interface gráfica de usuário (GUI), como Arquivo > Imprimir.

• Exemplos de saída de dispositivos Cisco são exibidos em fonte Courier; por exemplo (os comandos estão em negrito, não use cor diferente de preto):

3524xl# show running-config
Building configuration...

Current configuration:

!
version 12.0
no service pad
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!

• As mensagens de erro do sistema dos dispositivos Cisco são exibidas na fonte Courier; por exemplo:

• Um roteador reiniciado com o comando reload exibe a mensagem System returns to ROM by reload.

Mensagens e ícones de alerta

Observação: significa que o leitor deve tomar nota. As notas contêm sugestões úteis ou referências a materiais não abordados no documento. É recomendável ler qualquer Anotação no artigo.

Dica: significa que essas informações podem ajudá-lo a resolver um problema. As informações de dicas não podem ser uma sugestão para solucionar problemas de informações ou até mesmo uma ação, mas podem ser informações úteis. As dicas são de leitura opcional.

Cuidado: significa que o leitor deve ter cuidado. Nessa situação, sua ação pode resultar em danos ao equipamento ou perda de dados. Você deve ler as Instruções de cuidado.

Aviso: Aviso significa perigo. Você está em uma situação que poderia causar ferimentos corporais. Antes de trabalhar em qualquer equipamento, você deve estar ciente dos perigos envolvidos com os circuitos elétricos. Você deve estar familiarizado com as práticas padrão de prevenção de acidentes. Para ver as versões traduzidas do aviso, consulte o documento Regulatory Compliance and Safety que acompanha o dispositivo. Você deve ler as instruções de Aviso.

O ícone de saída  mostra que você está prestes a sair do site da Cisco. Essa imagem aparece no final de um link para sites externos a Cisco.com e é aberta em uma janela separada do navegador. A Cisco não se responsabiliza pelo conteúdo de outros sites. 

Comandos do software Cisco IOS^®

As próximas convenções para comandos do Cisco IOS também são usadas nos guias de referência de comandos. Para obter mais informações sobre convenções na documentação do Cisco IOS, consulte o Cisco Technical Content Style Guide . 

• Barras verticais | ) argumentos alternativos e mutuamente exclusivos. Exemplo: req-qos {melhor-esforço | carga-controlada | atraso-garantido}

• Os colchetes ([ ]) indicam elementos opcionais. Exemplo: [no] ip route-cache [cbus]

• As chaves ({ }) indicam uma opção obrigatória. Exemplo: número da lista de acesso [{permit | deny}]

• As chaves dentro de colchetes ([{ }]) indicam as opções obrigatórias dentro de elementos opcionais.

• Colchetes angulares (< >) indicam argumentos em contextos que não permitem itálico e, em exemplos, indicam sequências de caracteres inseridas pelo usuário que não aparecem na tela (por exemplo, uma senha).

• Negrito indica comandos e palavras-chave.

• Itálico indica variáveis do usuário.

Exemplos de configuração

Nomes de roteadores, nomes de hosts, nomes de usuários, senhas e endereços IP genéricos são usados em exemplos de configuração genéricos. Eles devem ser substituídos por nomes, senhas e endereços apropriados para a sua empresa.

Cuidado: não use o nome de usuário cisco ou a senha cisco em suas configurações. Usar cisco como senha ou nome de usuário, ou usar qualquer senha trivial, é um risco à segurança. Observe também que não é recomendável incluir a Cisco no título do artigo.

• Nomes de roteador: RouterX, nasX e assim por diante.

• Telefones: 555nnnn

Endereços IP

Cuidado: os endereços IP estão em conformidade com as definições RFC 1918 de endereços de rede privada. Veja a imagem abaixo. Houve uma violação recente devido a um endereço IP de cliente exposto em um artigo da Cisco.com. Use o discernimento e a cautela ao incluir um endereço IP em qualquer lugar do artigo. Verifique suas imagens quanto a endereços IP que possam estar violando isso.

Três blocos de endereços IP estão reservados pela Internet Assigned Numbers Authority (IANA) para Internets particulares:

• Intervalo: 10.0.0.0 - 10.255.255.255 (prefixo 10/8)

• Intervalo: 172.16.0.0 - 172.31.255.255 (prefixo 172.16/12)

• Intervalo: 192.168.0.0 - 192.168.255.255 (prefixo 192.168/16)

Referência de endereço IP

Endereços IP Reservados para Documentação Pública

Comentários em blocos de código

Freqüentemente, comentários são incluídos nos exemplos de configuração. Os comentários estão em itálico. Elas devem ser mostradas somente como texto em preto; as cores são inaceitáveis, exceto quando aparecem em uma captura de tela. Elas fornecem mais informações sobre a saída e comandos de configuração usados. Os comentários de configuração são semelhantes a:

!--- Define IPSec traffic of interest. 
!--- This line covers traffic between the LAN segment behind two PIXes. 
!--- It also covers the SNMP/syslog traffic between the SNMP/syslog server 
!--- and the network devices located on the Ethernet segment behind PIX 515.

access-list 101 permit ip 172.18.124.0 255.255.255.0 10.99.99.0 255.255.255.0 

Observação: é recomendável encurtar os exemplos de codeblock para que nenhum controle deslizante seja exibido no final do exemplo.

Informações Relacionadas

• RFC 1918
• Guia de estilo de conteúdo técnico da Cisco
• Suporte técnico e downloads da Cisco