DokuWiki

It's better when it's simple

Strumenti Utente

Strumenti Sito


Barra laterale

Questa traduzione è più vecchia di quella della pagina originale è potrebbe essere superata. Vedi cosa è cambiato.
Traduzioni di questa pagina?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

Our Privacy Policy

it:tips:good_style

Suggerimenti di buon stile

Questi sono alcuni consigli su come scrivere una buona pagina wiki.

Struttura pagina

  • Si inizi la propria pagina con un'intestazione di primo livello con un titolo significativo.
  • Si nidifichino i livelli nel loro ordine corretto, le sezioni nel secondo livello dovrebbero iniziare con un titolo di secondo livello.
  • Si suddivida il proprio testo in paragrafi, lasciando una riga vuota tra essi. Un paragrafo medio non dovrebbe essere più lungo di 10-20 righe.
  • Se il testo è più lungo di alcuni (3-5) paragrafi, si consideri la suddivisione in sezioni aggiungendo livelli di intestazioni dal secondo al quinto.
  • Quando il testo diventa più lungo di 2-3 pagine dello schermo, si inserisca un breve sommario dei contenuti della pagina dopo la prima intestazione. Quando la pagina diviene significativamente più lunga si consideri di dividerla in più pagine.
  • Se si hanno molti collegamenti ad altre pagine del wiki o risorse esterne, si aggiunga una sezione speciale con ulteriori riferimenti (si veda sotto).
  • Se la maggior parte delle pagine di una categoria condividono una struttura comune si aggiunga un modello di categoria così ogni nuova pagina può iniziare con quello schema di struttura.
  • Si cerchi di evitare strutture di categorie eccessivamente complicate. Si cerchi di usare nomi di categorie brevi, facili da ricordare.

Formattazione testo

  • Si enfatizzino singole parole o brevi brani di testo utilizzando il grassetto o il corsivo. Se ne scelga uno e si mantenga la scelta.
  • Si scelga uno stile per rappresentare i risultati e i testi a video come bottoni o menu etichette e lo si usi in modo coerente. Potrebbe essere una buona idea aggiungere una pagina con una spiegazione delle convenzioni di stile adottate nel proprio wiki.
  • Si usino liste non ordinate per espressioni indipendenti l'una dall'altra. Se si sta sviluppando una linea di pensiero, si scriva una sequenza continua di frasi.
  • Si usino note a piè di pagina con parsimonia e solo per commenti aggiuntivi molto brevi. Se c'è molto altro da dire su un argomento specifico, lo si inserisca su una nuova pagina wiki. Se si vuole fare riferimento ad altre fonti di informazioni (esterne), si usino invece i collegamenti.
  • Le tabelle possono migliorare notevolmente la leggibilità dei dati strutturati. Se si inserisce una tabella, assicurarsi che abbia intestazioni di cella significative e si fornisca una didascalia che indichi chiaramente il contenuto della tabella (ad esempio “Tabella 1.2: distanza media tra i pianeti”).
  • Le tabelle di grandi dimensioni tendono ad essere molto difficili da modificare. Si consideri, in alternativa, di rappresentare i dati in un elenco nidificato.

Lingua

  • Si scrivano frasi appropriate e si usino gli articoli per i sostantivi quando necessari.
  • Si inizi ogni frase con una lettera maiuscola e la si concluda con un punto o altri segni di punteggiatura appropriati.
  • Si provi a scrivere frasi brevi, chiare, senza ricorrere troppo a frasi subordinate. Quando si pensa di aver finito la propria pagina, la si rilegga ancora e si corregga ogni frase che ha una struttura troppo complessa.
  • Si decida come rivolgersi ai propri lettori. Poiché DokuWiki è orientato verso la scrittura di documentazione, sarà spesso necessario istruire i lettori, su come fare certe cose. È possibile utilizzare la forma imperativa (“Fai questo!”), la forma noi/voi/tu/lei oppure la forma impersonale. Non si mescolino queste forme.
  • Si controlli la propria pagina per eventuali errori grammaticali o di ortografia prima di salvarla. Se il testo presenta molti errori, si riduce la credibilità delle dichiarazioni scritte, indipendentemente da quanto ben pensate possano essere.
  • Si sviluppi il proprio stile. Non si facciano sforzi per scrivere in un modo che non si sente proprio. Questo sarebbe innaturale e sgradevole da leggere.

Riferimenti

  • Quando si incontra un termine che necessita si maggiori spiegazioni, si aggiunga una nuova pagina wiki per il termine e si crei un collegamento ad essa.
  • Si ricontrolli la propria pagina prima di concluderla, e si aggiungano collegamenti alle esistenti pagine wiki che trattano i termini centrali della pagina.
  • Non si aggiunga un collegamento ad ogni occorrenza di uno specifico termine. Si crei un collegamento dalla prima/più importante occorrenza sulla pagina e magari si aggiunga un collegamento nella sezione riferimenti.
  • Si forniscano collegamenti alle fonti di immagini, dati e citazioni.
  • Si consideri di aggiungere un riga “Si veda anche” alla fine della propria pagina. Si forniscano collegamenti a pagine wiki strettamente legati al tema della propria pagina.
  • Se si vuole dare indicazioni su risorse esterne che forniscono ulteriori informazione sul proprio argomento o che si sono usate per scrivere la propria pagina, si aggiunga una sezione chiamata “Riferimenti” o “Ulteriori informazioni” alla fine e si fornisca un elenco di collegamenti o altre indicazioni (ad esempio numeri ISBN). Se non è stato fatto nel testo principale, si dichiarino le intenzioni dei riferimenti.
  • Impostando scorciatoie interwiki può aiutare a collegare risorse comuni.

Immagini e altri media

  • “Un'immagine dice più di mille parole.” Potrebbe anche significare più di quanto si intendeva dire. Gli esseri umani tendono a dubitare dell'autenticità delle immagini meno di quella del linguaggio. Una breve descrizione testuale è comunque meglio di niente o di un'immagine inappropriata.
  • Come per le tabelle, si inserisca sempre una didascalia delle immagini, che indica ciò che si vuole mostrare con l'immagine.
  • Se non si è l'autore dell'immagine, si indichi la fonte (possibilmente con un collegamento) e il diritto d'autore.
  • Non si creino collegamenti a immagini di siti esterni, se non si è autorizzati a farlo esplicitamente. Questo è in primo luogo un problema di diritti d'autore, ma potrebbe anche essere considerato una questione di ampiezza di banda quando la caching for external images è disattivata.
  • Se l'immagine è più grande di circa un terzo di una schermata, si utilizzi un collegamento con istruzioni di ridimensionamento per inserire una miniatura.
it/tips/good_style.txt · Ultima modifica: 2011-07-27 15:47 da 78.4.240.40