Guida di stile alla documentazione per i collaboratori

Quanto segue definisce i requisiti di base per la formattazione del tuo articolo di documentazione.

Riferimenti

Linee guida per i collaboratori

Glossario dei termini

Pagine di panoramica

Un articolo che introduce una sezione con introduzioni e link alle sottosezioni.

Paragrafo introduttivo

Link alle sezioni con brevi descrizioni

Usa un rientro per formattare ogni link
Il link è identico a come appare nel menu
Il link è seguito da una lineetta (spazio-lineetta-spazio) e poi da una o due frasi introduttive alla sottosezione che descrivono come essa approfondisce l'argomento generale

Il paragrafo di riepilogo collega la sezione alla categoria, ad esempio collega un argomento di gestione dei contenuti a Gestione contenuti.

Link a una sottosezione

Link alle sottosezioni

Titoli

Maiuscole nei titoli (stile anglosassone)

Maiuscolo

La prima e l'ultima parola (sempre)
Sostantivi, verbi, aggettivi, avverbi
Parole di 4 o più lettere (regola empirica comune)

Minuscolo

Preposizioni brevi: in, on, at, by, for, of, up, to
Articoli: a, an, the
Congiunzioni brevi: and, but, or, nor, so, yet

Esempio

A Guide to the Rules of Title Case and How to Use Them

E commerciale &

Da usare nei menu solo come sostituto della parola "and", ma mai nei titoli degli articoli.

Voce di menu

6 Pagination & Read More

Titolo articolo

6 Pagination and Read More

Numerazione

Quando il contenuto segue una struttura numerata o un indice, non aggiungere punti dopo il numero.

Sì

6 Pagination and Read More

No

6. Pagination and Read More

Screenshot

Consulta Suggerimenti per screenshot migliori per indicazioni dettagliate.

Note: larghezza 1500–2500px; sfondo del browser chiaro (non scuro); ritaglia in modo appropriato per orientare l'utente e mostrare i dettagli rilevanti; usa lo zoom del browser per migliorare il testo; formato file PNG.

Didascalie

Quando configurata con una didascalia (clic destro e spunta la casella della didascalia), l'immagine viene racchiusa in un blocco <figure> con la didascalia appropriata; altrimenti l'immagine viene mostrata in una condizione inline standard.

Posizionamento

Dimensione

Larghezze standard: 960px per la larghezza piena, e 320px o 640px per larghezze parziali.

Le larghezze grandi (superiori a 1000px) vengono ridimensionate automaticamente nel browser alla larghezza dell'articolo. Le immagini più piccole sono allineate a sinistra.

Attribuzione

Se lo screenshot include immagini, dovremmo attribuire la fonte? E come?