ho cercato ma non ho trovato delle linee guida sullo stile da adottare nel wiki; intendo cose come "nell' howto che stai scrivendo, è meglio se ti rivolgi al lettore dando del tu" o il voi, o impersonale, "è preferibile la parola ubuntu piuttosto che linux per non creare confusione nel lettore", "quando puoi, indica la procedura grafica insieme a quella per il terminale", "l'articolo dovrebbe essere impersonale(è un wiki,non un blog o un forum)" , " evitare le abbreviazioni da sms(scrivere cmq al posto di comunque non fa una bella impressione)" eccetera...
Se esiste una guida del genere, potete darmi il link, chè non lo trovo?
grazie
«Dice fai così e così e vedi se c'è da qualche parte (!) la riga... se non c'è aggiungila... A chi? Ma se mi sono presentato come "meno che neofita"! Scusa dav2dev, ma tu così spaventi la gente!»
DaViDuZZo ha scritto:
ho cercato ma non ho trovato delle linee guida sullo stile da adottare nel wiki; intendo cose come "nell' howto che stai scrivendo, è meglio se ti rivolgi al lettore dando del tu" o il voi, o impersonale, "è preferibile la parola ubuntu piuttosto che linux per non creare confusione nel lettore", "quando puoi, indica la procedura grafica insieme a quella per il terminale", "l'articolo dovrebbe essere impersonale(è un wiki,non un blog o un forum)" , " evitare le abbreviazioni da sms(scrivere cmq al posto di comunque non fa una bella impressione)" eccetera...
Fino a tanto non ci eravamo spinti, c'è solo per lo stile "grafico" da adottare come indicato da peppe, comunque penso sia ora di creare anche questa...
Grazie per lo spunto!
PS: le abbreviazioni da SMS dovrebbe essere naturale non scriverle!
Fino a tanto non ci eravamo spinti, c'è solo per lo stile "grafico"
Ah,ecco, mi sembrava strano che non la riuscivo a trovare...
Cmq ( :P ) sono d'accordo,è una guida da fare assolutamente!
«Dice fai così e così e vedi se c'è da qualche parte (!) la riga... se non c'è aggiungila... A chi? Ma se mi sono presentato come "meno che neofita"! Scusa dav2dev, ma tu così spaventi la gente!»
E se intanto cominciassimo a buttare giù qualche idea?
Ad esempio secondo me è meglio scrivere "riavviare il computer" che "riavviare la macchina", perchè macchina lo vedo più come un termine da professionista, sicuramente poco usato dagli utenti comuni. Saranno dettagli, ma secondo più sono semplici i termini e più il lettore si sentirà "a casa" e sarà meno spaesato.
«Dice fai così e così e vedi se c'è da qualche parte (!) la riga... se non c'è aggiungila... A chi? Ma se mi sono presentato come "meno che neofita"! Scusa dav2dev, ma tu così spaventi la gente!»
Magari spiegare anche termini del tipo: Anchor, Typo etc.
Peppe84 sulla mail di qualche settimana per guida wiki non esaustiva intendevo proprio quello che viene fuori da questo topic: chi è alle prime armi e ha voglia di fare si trova un pò in difficoltà all'inizio. Certo poi comunque (almeno per me), grazie anche ai consigli di chi è più esperto, si capisce come bisogna scrivere una pagina wiki. (good)
Ex "Membro del Consiglio, Sysadmin e Web-Designer dei portali della comunità, Amministratore del Sito e tante altre cose..." Con Ubuntu-it dal maggio del 2006.
L3oN ha scritto:
Secondo me si potrebbe anche inserire un nuovo capitolo in GuidaWiki/StileDellePagine.
si anche perchè tanto si tratterà di un paio di elenchi puntati.
se non ci sono obiezioni procederei così:
il paragrafo Stili da adottare lo chiamerei Stile tipografico da adottare (suggeritemi un titolo più efficare) e aggiungere un paragrafo Stile di scrittura.
Ultima modifica di peppe84 il giovedì 22 marzo 2007, 15:41, modificato 1 volta in totale.
"tipografico" mi sa che riguarda altro; io rimarrei sul semplice "stile di scrittura"
«Dice fai così e così e vedi se c'è da qualche parte (!) la riga... se non c'è aggiungila... A chi? Ma se mi sono presentato come "meno che neofita"! Scusa dav2dev, ma tu così spaventi la gente!»
L3oN ha scritto:
Secondo me si potrebbe anche inserire un nuovo capitolo in GuidaWiki/StileDellePagine.
si anche perchè tanto si tratterà di un paio di elenchi puntati.
+1
anche io credo non ci sarà molto da aggiungere, oltre all'avvertenza sull'uso della forma impersonale.
Ho dato una lettura veloce a questa pagina su Wikipedia (piuttosto ridondante rispetto ai nostri scopi), magari si può trarre ispirazione per un altro paio di indicazioni di massima.
peppe84 ha scritto:
se non ci sono obiezioni procederei così:
il paragrafo Stili da adottare lo chiamerei Stile tipografico da adottare (suggeritemi un titolo più efficare) e aggiungere un paragrafo Stile di scrittura.
Non l'ho ancora visto perché stavo buttando giù questo.
Posto lo stesso qualche mia considerazione per quanto riguarda lo stile e l'uso del Wiki:
Sarebbe meglio aprire un documento con un'introduzione (Introduzione) e chiuderlo con un paragrafo dedicato agli approfondimenti o a riferimenti esterni (Ulteriori risorse). Se si tratta di traduzione è sempre importante citare il documento originale, sia per correttezza sia per metterlo a disposizione di chi volesse approfondire o verificare le procedure di una guida.
È opportuno adottare uno stile di scrittura neutro o impersonale, che dir si voglia.
Lo stile, inoltre, dovrebbe essere sobrio (no blog e affini, come si diceva prima) e possibilmente schematico, ma sempre chiaro: occhio a non dare per scontati certi passaggi tecnici, ma non è il caso di inserire ogni volta le due procedure per lanciare i comandi (terminale con apt e synaptic o altro per la modalità grafica): piuttosto inserire in introduzione un link alle guide relative.
Va evitato l'uso del plurale per i termini stranieri.
In linux non esistono "cartelle", ma directory.
Nomi di file (sul sistema o altrove) e percorsi nel filesystem andrebbero messi in carattere a spaziatura fissa, per evidenziarli meglio dal testo circostante. Per ottenere questo effetto si usino gli apici inversi `testo`. Le {{{}}} sono sintatticamente corrette (per il parser del Wiki) ma forse è meglio non usarle poiché già utilizzate per il "campo codice".
Il campo codice viene reso con {{{}}}. Le prime tre in apertura vanno inserite sulla stessa riga in cui viene introdotta la procedura riportata nel campo codice. Quindi: "digitare da terminale: {{{ ".
Le graffe di chiusura vanno inserite da sole in una nuova riga dopo il termine del codice riportato. Quindi:
" bla bla bla
sudo apt-get install xchat
}}}"
I titoli dei paragrafi dovrebbero essere chiari e specifici, ma non troppo lunghi.
È utile l'uso degli Anchor sui titoli (o altrove, se vi è necessità) per i rimandi interni ai documenti.
L'indice del documento (anche detto ToC) non dovrebbe essere né troppo largo né troppo lungo: nel caso, modificare la larghezza della tabella impostando un diverso valore percentuale e porre n=1, 2 nella macro [[TableOfContents(n)]].
La formattazione in grassetto andrebbe riservata ai nomi dei programmi, ai percorsi nei menù, alle opzioni, e a quant'altro abbia una funzionalità ben delineata.
I nomi di pacchetti software (quelli da installare con apt-get o synaptic, per capirsi) andrebbero formattati in corsivo e non in grassetto.
Il normale testo non andrebbe formattato in grassetto per non appesantire (o sviare l'attenzione da) la lettura del contenuto. L'enfasi, ma sempre per brevissimi tratti di testo, si può ottenere con il corsivo o il sottolineato. Unica deroga a tale limite è quella relativa al suo uso nelle note col testo in tabella: anche in questo caso, se si tratta di note con testo lungo, sarebbe buona norma evidenziare in gassetto soltanto la parte effettivamente critica/importante.
Precisazione marginale e pignola : quando si dice "un wiki" si intende un tipo di software o piattaforma per la scrittura e gestione dei contenuti, quando ci si riferisce ad una guida nel wiki è meglio semplicemente dire pagina o documento.
Ovviamente non sono da intendersi come norme "scolpite nella pietra": una certa elasticità è consentita (a volte assolutamente necessaria).
io metterei stile di scrittura prima di norme sulla formattazione, mi pare più importante scrivere bene un articolo, che formattarlo bene; e poi un articolo formattato male, ci vuole poco a correggerlo(anche se magari è noioso), mentre un periodo incasinato ci vuole più tempo e sforzo per riscriverlo in una forma più lineare. Ovviamente imho.
Prendendo anche spunto dalla pagina di wikipedia, proporrei di aggiungere altri punti:
* frasi brevi e concise sono preferibili a frasi troppo lunghe e piene (o completamente vuote) di virgole
* cercare sempre di spiegare cosa fa un comando inusuale (->1)
* evitare di scrivere parole tutto in maiuscolo
* fornire esempi dei comandi citati, o link ad articoli che ne parlano(-> 2)
* evitare frasi come "bello,no?:)" , "semplice,vero?" eccetera
1 -> perchè l'utente potrebbe rinunciare ad usare un comando mai visto, se non gli si anticipano gli effetti del comando(ad esempio io rinunciavo a usare l'autenticazione a chiave pubblica per paura di fare casini, perchè dall'sshhowto non capivo cosa e dove andavo a modificare il sistema con i comandi proposti)
2 -> se gli fai vedere solo la sintassi, usando ad esempio un astratto @, l'utente rimane col dubbio (le parentesi angolari le devo mettere?e la chiocciola?) , mentre se gli mostri anche l'esempio mario@23.133.98.88 i dubbi spariscono e si acquisisce familiarità con la sintassi
@guglielf
molti dei punti che hai scritto sono già presenti nella guida attuale, e sono riferiti più che altro alla formattazione, quindi secondo me stanno già bene dove stanno.
«Dice fai così e così e vedi se c'è da qualche parte (!) la riga... se non c'è aggiungila... A chi? Ma se mi sono presentato come "meno che neofita"! Scusa dav2dev, ma tu così spaventi la gente!»
