Utilizar convenciones de formato para sugerencias técnicas y otro contenido

Introducción

Este documento describe los formatos para las convenciones de texto, imagen y comandos que se utilizan en las sugerencias técnicas y el contenido de Cisco.

Convenciones generales

Deben seguirse las convenciones generales para:

• Texto
• Alertas e iconos
• Comandos del software Cisco IOS®
• Ejemplos de Configuración
• Direcciones IP (Tenga cuidado aquí.)
• Comentarios en bloques de código

Texto

• El texto en negrita indica el texto que el usuario debe ingresar o seleccionar, como por ejemplo: botones, comandos y elementos del menú.

• La cursiva indica énfasis.

• El paréntesis angular de avance ( >) indica la progresión de las opciones del menú que el usuario debe seleccionar en una interfaz gráfica de usuario (GUI), como Archivo > Imprimir.

• Los ejemplos de salida de los dispositivos Cisco se muestran con la fuente Courier; por ejemplo (los comandos están en negrita, no utilizan colores distintos del negro):

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
!

• Los mensajes de error del sistema de los dispositivos Cisco se muestran en la fuente Courier; por ejemplo:

• Un router reiniciado con el comando reload muestra el mensaje System return to ROM by reload.

Mensajes de alerta e iconos

Nota: Significa que el lector toma nota. Las notas contienen sugerencias de gran ayuda o referencias a material que no se encuentra en el documento. Se recomienda que lea cualquier nota del artículo.

Sugerencia: significa que esta información puede ayudarle a resolver un problema. La información de sugerencias no puede ser una forma sugerida de solucionar problemas de información o incluso una acción, pero podría ser información útil. Las sugerencias son lecturas opcionales.

Precaución: Significa que el lector debe tener cuidado. En esta situación, su acción podría provocar daños en el equipo o la pérdida de datos. Debe leer las declaraciones de precaución.

Advertencia: Advertencia significa peligro. Usted está en una situación que podría causar lesiones físicas. Antes de trabajar en cualquier equipo, debe ser consciente de los peligros que implica la corriente eléctrica. Debe estar familiarizado con las prácticas estándar para la prevención de accidentes. Para ver versiones traducidas de la advertencia, consulte el documento Cumplimiento de normas y seguridad que acompaña al dispositivo. Debe leer las declaraciones de advertencia.

El icono de salida  muestra que está a punto de salir del sitio web de Cisco. Esta imagen aparece al final de un enlace a sitios web externos a Cisco.com y se abre en una ventana de explorador independiente. Cisco no se hace responsable del contenido de otros sitios web. 

Comandos del software Cisco IOS^®

Las siguientes convenciones para los comandos de Cisco IOS también se utilizan en las guías de referencia de comandos. Para obtener más información sobre las convenciones en la documentación de Cisco IOS, refiérase a la Guía de Estilo de Contenido Técnico de Cisco . 

• Barras verticales ( | ) argumentos alternativos y mutuamente excluyentes. Ejemplo: req-qos {best-effort | controlled-load | warranty-delay}

• Los corchetes ([ ]) se refieren a elementos opcionales. Ejemplo: [no] ip route-cache [cbus]

• Las llaves ({ }) indican una opción obligatoria. Ejemplo: access-list number [{permit | deny}]

• Las llaves entre corchetes ([{ }]) indican las opciones necesarias dentro de los elementos opcionales.

• Los corchetes angulares (< >) indican argumentos en contextos que no admiten cursiva y, en los ejemplos, indican cadenas de caracteres que el usuario introduce y que no aparecen en la pantalla (por ejemplo, una contraseña).

• Negrita indica comandos y palabras clave.

• Las cursivas indican variables de usuario.

Ejemplos de Configuración

En los ejemplos de configuración se utilizan nombres genéricos de routers, nombres de computadoras principales, contraseñas y direcciones IP. Deben sustituirse por los nombres, las contraseñas y las direcciones correspondientes a su empresa.

Precaución: no utilice el nombre de usuario cisco o la contraseña cisco en sus configuraciones. Utilizar cisco como contraseña o nombre de usuario, o utilizar cualquier contraseña trivial, supone un riesgo para la seguridad. También tenga en cuenta que no se recomienda incluir Cisco en el título del artículo.

• Nombres de router: RouterX, nasX, etc.

• Números de teléfono: 555nnnn

Direcciones de IP

Precaución: las direcciones IP cumplen con las definiciones de direcciones de red privada de RFC 1918. Consulte la imagen siguiente. Se ha producido una brecha reciente debido a una dirección IP de cliente expuesta en un artículo de Cisco.com. Use juicio y precaución cuando incluya una dirección IP en cualquier parte de su artículo. Compruebe las imágenes para ver si hay direcciones IP que puedan infringir este principio.

La Autoridad de números asignados de Internet (IANA) reserva tres bloques de direcciones IP para las Internet privadas:

• Rango: 10.0.0.0 - 10.255.255.255 (prefijo 10/8)

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

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

Referencia de dirección IP

Direcciones IP Reservadas para Documentación Pública

Comentarios en bloques de código

A menudo, se incluyen comentarios en los ejemplos de configuración. Los comentarios aparecen en cursiva. Se deben mostrar sólo como texto en negro; los colores son inaceptables excepto cuando aparecen en una captura de pantalla. Brindan más información acerca del resultado de la configuración y los comandos utilizados. Los comentarios de configuración son similares 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 

Nota: se recomienda acortar los ejemplos de bloques de código para que no aparezca ningún control deslizante al final del ejemplo.

Información Relacionada

• RFC 1918
• Guía de estilo de contenido técnico de Cisco
• Asistencia técnica y descargas de Cisco