Utilizzare le convenzioni di formato per i suggerimenti tecnici e altri contenuti

Introduzione

Questo documento descrive i formati per il testo, le immagini e le convenzioni dei comandi usati nei suggerimenti tecnici e nei contenuti Cisco.

Convenzioni generali

Le convenzioni generali devono essere rispettate per:

• Testo
• Avvisi e icone
• Comandi del software Cisco IOS®
• Esempi di configurazione
• Indirizzi IP (fare attenzione qui).
• Commenti nei blocchi di codice

Testo

• Il grassetto indica il testo che l'utente deve immettere o selezionare, ad esempio voci di menu, pulsanti e comandi.

• Il corsivo indica l'enfasi.

• La parentesi angolare ( >) indica la progressione delle scelte di menu che l'utente deve selezionare in un'interfaccia utente grafica (GUI), ad esempio File > Stampa.

• Gli esempi di output dei dispositivi Cisco vengono visualizzati nel carattere Courier; ad esempio (i comandi sono in grassetto e non usano colori diversi dal nero):

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
!

• I messaggi di errore di sistema provenienti dai dispositivi Cisco vengono visualizzati con il carattere Courier, ad esempio:

• Un router riavviato con il comando reload visualizza il messaggio System returns to ROM by reload.

Messaggi di avviso e icone

Nota: indica che il lettore prende nota. Le note contengono utili suggerimenti o riferimenti a materiale non trattato nel documento. Si consiglia di leggere qualsiasi nota contenuta nell'articolo.

Suggerimento: indica che queste informazioni possono essere utili per risolvere un problema. Le informazioni sui suggerimenti non possono essere un metodo consigliato per risolvere i problemi relativi alle informazioni o a un'azione, ma possono essere utili. I suggerimenti sono letture facoltative.

Attenzione: il lettore deve prestare attenzione. In questo caso, l'azione potrebbe causare danni alle apparecchiature o la perdita di dati. È necessario leggere le avvertenze.

Attenzione: avvertenza significa pericolo. Ti trovi in una situazione che potrebbe causare lesioni corporali. Prima di lavorare su qualsiasi apparecchiatura, è necessario essere consapevoli dei pericoli connessi con i circuiti elettrici. Devi conoscere le procedure standard per la prevenzione degli incidenti. Per vedere le versioni tradotte dell'avvertenza, consulta il documento sulla conformità e la sicurezza normativa fornito con il dispositivo. È necessario leggere le istruzioni Warning.

Icona di uscita  indica che si sta per uscire dal sito Web Cisco. Questa immagine viene visualizzata alla fine di un collegamento a siti Web esterni a Cisco.com e viene aperta in una finestra del browser separata. Cisco non è responsabile del contenuto di altri siti Web. 

Comandi software Cisco IOS^®

Le convenzioni successive per i comandi Cisco IOS sono usate anche nelle guide di riferimento dei comandi. Per ulteriori informazioni sulle convenzioni nella documentazione di Cisco IOS, consultare la Cisco Technical Content Style Guide. 

• Barre verticali ( | ) argomenti alternativi separati che si escludono a vicenda. Esempio: req-qos {massimo sforzo | carico controllato | ritardo garantito}

• Le parentesi quadre ([ ]) indicano gli elementi facoltativi. Esempio: [no] ip route-cache [cbus]

• Le parentesi graffe ({ }) indicano una scelta obbligatoria. Esempio: access-list number [{allow | deny}]

• Le parentesi quadre ([{ }]) indicano le scelte obbligatorie negli elementi facoltativi.

• Le parentesi angolari (< >) indicano gli argomenti nei contesti che non consentono il corsivo e negli esempi indicano le stringhe di caratteri immesse dall'utente che non vengono visualizzate sullo schermo, ad esempio una password.

• Il grassetto indica comandi e parole chiave.

• Il corsivo indica le variabili utente.

Esempi di configurazione

Negli esempi di configurazione vengono utilizzati nomi di router, nomi host, nomi utente, password e indirizzi IP generici. Devono essere sostituiti con i nomi, le password e gli indirizzi appropriati per la tua azienda.

Attenzione: non usare nome utente cisco o password cisco nelle configurazioni. Utilizzare cisco come password o nome utente o come password semplice costituisce un rischio per la sicurezza. Si consiglia inoltre di non includere Cisco nel titolo dell'articolo.

• Nomi dei router: RouterX, nasX e così via.

• Numeri di telefono: 555nnnn

Indirizzi IP

Attenzione: gli indirizzi IP sono conformi alle definizioni RFC 1918 degli indirizzi di rete privati. Vedere l'immagine seguente. Di recente si è verificata una violazione dovuta a un indirizzo IP del client esposto in un articolo di Cisco.com. Valutare attentamente se si inserisce un indirizzo IP in un punto qualsiasi dell'articolo. Verificare nelle immagini se sono presenti indirizzi IP che potrebbero violare questa regola.

Tre blocchi di indirizzi IP sono riservati da IANA (Internet Assigned Numbers Authority) a Internet private:

• Range: 10.0.0.0 - 10.255.255.255 (prefisso 10/8)

• Range: 172.16.0.0 - 172.31.255.255 (prefisso 172.16/12)

• Intervallo: 192.168.0.0 - 192.168.255.255 (prefisso 192.168/16)

Riferimento indirizzo IP

Indirizzi IP riservati alla documentazione pubblica

Commenti nei blocchi di codice

Spesso i commenti vengono inclusi negli esempi di configurazione. I commenti sono in corsivo. Devono essere mostrate solo come testo nero; i colori sono inaccettabili tranne quando appaiono in una schermata. Forniscono ulteriori informazioni sull'output della configurazione e sui comandi utilizzati. I commenti relativi alla configurazione sono simili 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: si consiglia di abbreviare gli esempi di blocco di codice in modo che non venga visualizzato alcun dispositivo di scorrimento alla fine dell'esempio.

Informazioni correlate

• RFC 1918
• Guida di stile ai contenuti tecnici Cisco
• Supporto tecnico e download Cisco