IT:Wiki guidelines
È buona cosa seguire le seguenti linee guida della Wiki quando si scrive una pagina wiki. Questo aiuta a creare una wiki utile e facile da usare, accessibile a tutti. WikiProject Cleanup è una pagina per coordinare il lavoro nella wiki in parte per migliorare la conformità a queste linee guida.
Leggibilità
Fa' sì che le pagine siano brevi e che usino un linguaggio semplice, senza tecnicismi. OpenStreetMap mira ad essere accessibile a tutti, e la nostra documentazione dovrebbe riflettere ciò. Calibra il tuo stile di scrittura al livello di ragazzi e nonni!
Alcune pagine wiki non possono fare a meno di essere una documentazione tecnica. Anche all'interno di esse dovremmo sforzarci di farci capire da utenti con vari livelli di abilità tecniche. Scrivi delle introduzioni semplici per presentare gli argomenti, e magari separa i dettagli più complessi spostandoli in pagine separate, più mirate.
Struttura
La wiki dev'essere organizzata in modo che le persone possano trovare facilmente ciò che stanno cercando dalla Pagina principale. I contenuti più importanti sono collegati direttamente alla pagina principale, ma altri collegamenti portano a "pagine iniziali" relative ad argomenti particolari. Queste sono il livello successivo in una sorta di gerarchia di navigazione; spesso sono pagine brevi con molti collegamenti e poco testo (note anche cime "portali"). C'è bisogno di lavoro per assicurarci che questo tipo di navigazione sia sempre efficace per i nuovi visitatori.
Conflitti tra informazioni
Il conflitto tra informazioni è da evitare. Le informazioni correnti sulle raccomandazioni su come applicare i tag devono essere coerenti. Se così non è, per favore contatta altri utenti per raggiungere un consenso. Le raccomandazioni per i tag dovrebbero idealmente corrispondere all'uso corrente dei tag, a meno di valide ragioni che dicano altrimenti.
Le proposte di cambiamento nell'uso dei tag sono un'eccezione a questa regola, tuttavia devono essere chiaramente identificate come proposte.
Duplicazione
La duplicazione è spesso da evitare poiché si rischia di dare informazioni in conflitto tra loro, e si aumenta il carico di lavoro. Se la duplicazione non è necessaria, bisogna sistemarla in modo da fornire un'unica sorgente per le informazioni. Ciò potrebbe richiedere una discussione con altri utenti! È OK riassumere un argomento in un'altra pagina, ma tale riassunto dovrebbe essere collegato alla pagina principale a riguardo.
Template:merge è usato per etichettare le pagine che richiedono una riorganizzazione in modo da rimuovere i duplicati.
Laddove la duplicazione è utile (ad esempio se le informazioni sono presentate in modo diverso in stile, struttura o per un pubblico differente), è importante essere chiari sul perché si è scelto di sdoppiare la pagina, e inserire dei collegamenti incrociati tra le varie copie in modo da evitare confusione. Se non c'è un buon motivo per la duplicazione, queste copie dovrebbero allora essere fuse assieme. Notare che una fusione non significa necessariamente che da due pagine se ne ottiene una: un possibile altro risultato è avere una pagina non tecnica di riassunto che è collegata a una pagina più tecnica e approfondita.
Convenzione sui titoli delle pagine
Si prega di seguire le convenzioni sull'uso delle lettere maiuscole di Wikipedia: Per titoli di pagina a più parole, lasciare le parole dopo la prima in minuscolo, a meno che esse siano nomi propri che andrebbero sempre in maiuscolo, anche in mezzo a una frase.
Non usare il "CamelCase" con cui le parole sono attaccate senza spaziature tra loro - MediaWiki permette di usare gli spazi come nel linguaggio comune. L'eccezione a questo si ha quando il titolo è il nome di qualcosa che tipicamente ha le parole tutte attaccate, come per esempio "OpenLayers".
I prefissi nei titoli di pagina sono stati usati frequentemente in passato (ad esempio il prefisso "WikiProject"). Ciò è perlopiù un'eredità scomoda, ma che non possiamo al momento correggere con facilità. Spostare tutte quelle pagine sarebbe un compito troppo grande. Creare nuovi schemi di prefissi per le pagine, tuttavia, è sconsigliato. Crea titoli di pagina con un linguaggio naturale, e usa collegamenti incrociati per creare una struttura all'interno dei contenuti delle pagine stesse. Per la discussione in corso su questo argomento, vedi Wiki organisation.
Introduzione
Le pagine dovrebbero iniziare con un breve paragrafo introduttivo composto da qualche frase. È bene che questo paragrafo includa il titolo in grassetto e spieghi di cosa parla la pagina. È spesso utile includere un collegamento a una pagina più generale e a pagine più specifiche, per aiutare la navigazione.
Questa sezione introduttiva deve comparire prima di ogni titolo interno (e prima dell'indice, per le pagine più lunghe). Notare che è abbastanza comune creare un primo titolo chiamato "Introduzione". Ciò dovrebbe essere ristrutturato in modo che almeno parte dell'introduzione si trovi in cima alla pagina prima di ogni titolo. Così si ottiene un layout consistente in tutta la wiki.
Collegamenti
Le pagine devono essere ricche di collegamenti, per aiutare gli utenti a trovare le informazioni che stanno cercando. I concetti importanti correlati alla pagina sono solitamente collegati nell'introduzione. Se non ti viene in mente una pagina correlata da collegare, forse non stai descrivendo l'argomento in termini sufficientemente ampi. Ti incoraggiamo inoltre a creare collegamenti ai concetti correlati anche in tutto il resto della pagina.
Collegare una sezione a una pagina principale
Il codice {{main|page name}} può essere usato sotto il titolo di una sezione per fornire un collegamento a una pagina principale correlata all'argomento di tale sezione.
La sezione, in tal caso, dovrebbe soltanto riassumere la pagina principale collegata (e di certo non deve entrare in conflitto con essa).
Il titolo della sezione normalmente deve essere lo stesso della pagina a cui è collegata.
Collegamenti a Wikipedia
I collegamenti a Wikipedia possono creare confusione. Collega a Wikipedia solo se è utile, e se il concetto non è già spiegato nella wiki di OSM. Se usi la sintassi interwiki [[wikipedia:page name]] per favore lascia il prefisso 'wikipedia:' dov'è cioè lascialo anche nel testo (ad esempio non usare [[wikipedia:page name|page name]], scrivi solo [[wikipedia:page name]]) dato che può creare molta confusione per la navigazione tra le pagine. Puoi tuttavia usare un template per rendere più esplicito il collegamento a Wikipedia: {{Wikipedia|en|Page name}}, oppure {{Wikipedia|en|Page name|text= no }} per tenere solamente l'icona senza la dicitura esplicita "su Wikipedia".
Non collegare una pagina Wikipedia laddove un titolo uguale o simile esiste già in questa wiki (ad eccezione dell'articolo stesso, per cui il collegamento può essere usato come riferimento per ulteriori informazioni sull'argomento trattato).
Pagine che trattano di un sito Web
Abbiamo tante pagine wiki dedicate alla descrizione di un qualche sito Web esterno (servizi di mappe, software, eccetera). Ovviamente un collegamento esterno a tali siti è di vitale importanza: il link principale dovrebbe essere posto tra parentesi dopo il titolo (che è in grassetto) nella primissima frase oppure con un collegamento, in un formato di testo più grande, su una riga tutta per sé dopo le prime frasi di descrizione.
In queste pagine non c'è bisogno di copiare le informazioni a proposito del prodotto che si possono trovare sul sito esterno. La pagina dovrebbe piuttosto descrivere il sito dal punto di vista di OSM. Sii neutrale ed evita di fare pubblicità con la tua descrizione, anche se è comunque consigliabile usare un linguaggio che promuove OSM e il suo utilizzo.
Elenchi di servizi e software
Abbiamo un certo numero di pagine che contengono elenchi puntati o tabelle di software e servizi. Se c'è già la pagina wiki a proposito del software, o anche se non c'è (collegamento in rosso), il formato preferito è un collegamento interno alla pagina della wiki di OSM seguito da un collegamento esterno al sito, tra parentesi. Questo può essere poi seguito da una breve descrizione o da altre colonne nella tabella. Dobbiamo mirare a fornire collegamenti sia alla pagina della wiki sia ai siti esterni anche quando la pagina wiki non esiste, in modo da incoraggiare una sana interconnessione nella wiki. I collegamenti rossi possono essere riempiti con degli articoli abbozzati, seguendo le linee guida di cui sopra.
Ad esempio:
- OpenLayers (openlayers.org) - Una libreria JavaScript per mostrare mappe.
In situazioni dove lo spazio è poco, come spesso accade nelle tabelle, si può usare la sintassi con i collegamenti numerati (come [1]) per abbreviare drasticamente il collegamento esterno. Si potrebbe anche lasciar stare del tutto il collegamento esterno e collegare soltanto la pagina wiki interna, dato che essa conterrà il collegamento esterno. Se la pagina wiki non esiste si potrebbe dare solo il collegamento esterno, ma è sempre meglio creare una pagina wiki con una descrizione abbozzata.
Categorie
Le categoria sono usate per raggruppare pagine per tipo, e i loro titoli seguono la stessa convenzione che le pagine normali della wiki.
Le categorie stesse possono essere raggruppate in categorie più grandi per creare una gerarchia di navigazione: ad esempio Category:Buses è raggruppato all'interno di Category:Public transport.
Le pagine possono far parte di può categorie ma non devono "spammarle". Una pagina relativa ai bus, (per esempio una pagina sulle fermate dei bus) dovrebbe essere categorizzata sotto "Bus" ma non anche come "Trasporto pubblico". Tuttavia, la pagina Bus principale deve essere compresa all'interno della categoria "Trasporto pubblico" così come in quella più specifica "Bus".
Una sola riga di introduzione deve essere fornita per ogni categoria, e dovrebbe in generale contenere un collegamento alla pagina principale più appropriata per l'argomento, la quale tipicamente ha lo stesso nome.
Ad esempio
'Pages relating to [[Public transport]] come introduzione alla categoria "Trasporto pubblico".
Quando si sceglie di categorizzare una pagina, è bene assicurarsi che appaiano al posto giusto nella lista di pagine della categoria.
Si guardi ad esempio alle pagine elencate in Category:Users in London. Sarebbero tutte elencate sotto la U a cause del prefisso 'User:', ma questo comportamento è stato corretto: ad esempio User:Harry Wood ha nella sua pagina il codice [[Category:Users in London|Harry Wood]] per essere inserito nella categoria "Users in London"; il testo dopo la '|' agisce come chiave di ordinamento, cioè la pagina verrà elencata nella categoria non come "User: Harry Wood" ma come "Harry Wood" soltanto, com'è giusto che sia.
Lingua
OpenStreetMap usa l'inglese britannico per le pagine generiche in inglese e le pagine di argomenti locali della Gran Bretagna. Le pagine che si occupano principalmente di argomenti statunitensi, per qualunque ragione, dovrebbero usare un inglese americano. Questo si applica in particolare alle pagine di luoghi in Mapping projects.
Traduzioni
Vedi Wiki Translation. Ciò include alcune riflessioni su quello a cui puntiamo con le traduzioni nella wiki; intanto, ancora non è chiaro se la wiki migrerà verso l'uso della Translate extension.
Formattazione delle date
Le date devono essere formattate in uno dei seguenti modi, a seconda della precisione richiesta:
- 1 Agosto 2009 (il formato normale, a meno che ci sia incertezza o se il giorno è di grande importanza; non c'è bisogno di aggiungere lo zero iniziale al numero del giorno)
- Mercoledì 1 Agosto 2009 (quando il giorno della settimana è importante)
- Agosto 2009 (se il giorno non è noto e non è importante)
- 2009-08-01 (formato fissato dallo standard ISO 8601, da usare nelle tabelle, in particolare quando il contenuto dovrà essere trasportato in più pagine tradotte; include uno zero esplicito a sinistra nei numeri del mese e del giorno)
- 2009-08 (anche qui, se il giorno non è noto e non è rilevante)
- 2009 (solo l'anno, senza il separatore delle migliaia)
- 'Presto' (Agosto 2009) (quando una previsione è stata fatta in un periodo particolare)
I suffissi ordinali (come in 1°, 1o, 2a, eccetera) non sono necessari, e i numeri di mesi e giorni devono essere scritti per intero. Evitare date incomplete che non sono chiare, ed evitare l'uso delle stagioni (l'estate nell'emisfero nord equivale all'inverno nell'emisfero sud!).
Modificare le descrizioni
Ricorda di riempire il campo "Summary" quando si modifica una pagina, per indicare cosa hai cambiato. Questo è di aiuto per gli altri utenti che modificano.