You are here: Home Associazione Collabora con noi
Document Actions

Collabora con noi

by Federico Casari last modified 2007-10-31 00:10

Conoscere Linux incentiva e promuove la collaborazione tra soggetti interni ed esterni all'associazione ad ogni livello e siamo disponibili a pubblicare documenti, guide e lavori altrui e a realizzare insieme progetti o manifestazioni, sempre purché attinenti agli scopi dell'associazione.

Attualmente siamo alla ricerca di persone disponibili a scrivere articoli e guide su Linux e informatica in generale, che conoscano bene un aspetto di Linux, come la programmazione, i servizi di rete, grafica o altro, e che vogliano condividere le proprie conoscenze con gli altri.

E' possibile mandare lavori o proposte di collaborazione direttamente ai responsabili di Conoscere Linux via email.

Qui di seguito alcune regole e consigli da seguire per la stesura di documentazione da proporre:

  • E' buona regola decidere PRIMA di iniziare a scrivere il documento gli obbiettivi da seguire; pensate a chi è rivolto il vostro scritto, cosa volete comunicare e quali conoscenze di base deve avere l'utente. Durante la stesura controllate di stare seguendo i propositi e gli oppiettivi fissati in partenza.
  • E' importante scrivere i italiano corretto, bisogna fare attenzione a grammatica, sintassi e accenti ("è" e non "é" mentre si scrive "perché" e non "perchè"); limitate le parole inglesi, se necessario spiagatene il significato in italiano; altrettanto vale per gli acronimi.
  • Date tutti i riferimenti necessari e ricordtevi la bibliografia.
  • Se serve un programma o bisogna seguire una procedura descritta in un altro sito lincateli o scaricateli in maniera da tenerla in locale sul nostro sito; se lincate in locale documenti coperti da copyright chiedete prima il permesso al proprietario del copyright; è buona norma far sapere in ogni caso all'autore che si sta utilizzando il suo lavoro e in quale modo.
  • Assegnate un titolo al vostro scritto e date, in una decina di righe, la descrizione del contenuto.


Guide

  • Struttura delle guide: qui di seguito la struttura generale per i documenti; questa struttura può essere adattata nel caso ci siano esigenze parrticolati, ma non dovrebbe essere modificata altrimenti.

Titolo
Indice dei capitoli
Riferimenti e link

Cap. 1
testo

Cap. 2
testo

e così via....

Ringraziamenti


  • Formato dei documenti: se usate solo testo usate un file di solo testo; niente documenti pdf, OpenOffice.org, TeX e tanto meno Office. Se volete inserire delle immagini nel documento potete usare un html (potete usare Composer di Mozilla o Nvu per creare in maniera visuale documenti .html).
  • Impaginazione: non perdete tempo in impaginazione e abbellimenti grafici, lo stile dei documenti viene gestito automaticamente dal sito, sarebbe lavoro sprecato; usate solo le funzioni di base come grassetto, sottolineato, ecc. Se serve, usate le tabelle per tenere ordinato il testo.
  • Usate delle immagini quando servono a chiarire i concetti; tenete a mente che quello che state scrivendo verrà pubblicato sul web, le immagini devono essere poco pesanti, al massimo 80-100 KB di immagini per ogni pagina che verrà visualizzata. Se spiegate come installare o utilizzare un programma allegate degli screen shot della fase di installazione o del programma funzionante.
  • Cercate di evitare battute geek, in particolare nei manuali per principianti; se state scrivendo una manuale per super-hacker sono tollerati deliri come "h4ck1|\|9", anche se sconsigliati; ricordatevi il primo punto della lista e agite di conseguenza.
  • KISS = keep it simple & stupid; cercate di andare al sodo, senza esagerare. Se volete scrivere un manuale avanzato di programmazione non ha senso spiegare da zero il funzionamento delle variabili; se pensate che serva rinfrescare al lettore alcune nozioni di base siate concisi, state facendo solo un richiamo; citate piuttosto le fonti e i testi in cui vengono approfondite le nozioni che state richiamando.
  • Testate tutti i comandi e le indicazioni che date.
  • Segnalate la distribuzione e la versione dei programmi a cui fate riferimento per il vostro scritto.
  • Cercate, per quanto possibile, di testare i comandi su varie distribuzioni e di essere il più generali per quanto possibile.

News

  • La lunghezza delle news può variare da poche righe ad alcune pagine, l'importante è essere concisi.
  • Se possibile, approfondite le news e chiaritene gli aspetti meno ovvi.
  • Citate sempre le fonti.
  • Verificte sempre le notizie PRIMA di pubblicarle.
  • Se fate commenti soppesate le parole (la diffamazione è un reato).
  • E' importante coordinare il lavoro con gli altri autori di notizie per non avere notizie duplicate e sprecare lavoro.

Recensioni

Libri

La recensione consiste di 2/3 pagine di testo contenente un riassunto del cotenuto del libro e un commento sulla sua qualità; la recensione ha lo scopo di dare un'idea al potenziale lettore di cosa aspettari dal libro e se questo è adatto alla sue esigenze.

Le censioni vanno inderogabilmente completate entro tre settimane dalla avvenuta ricezione del libro.

Ricordatevi di indicare:
  • L'autore/i.
  • La casa editrice.
  • Il codice ISBN (International Standard Book Number), serve a identificare il libro.
  • Il prezzo di copertina.
  • Il numero di pagine.
  • La lingua in cui è scritto.
  • Il target di utenti a cui è indirizzato (tenete conto per il giudizio che ne date).
  • E' buona regola documentarsi sull'autore/i.
  • Se possibile fate un confronto con altri volumi che trattino argimenti simili .
  • Riportate l'indice o parte di esso e, se vi sembra utile, anche alcuni estratti.

Programmi

  • Per prima cosa è fondamentale spiegare che cosa fa un determinato programma e i requisiti per farlo funzionare.
  • Indicate sempre la distribuzione a cui fate riferimento.
  • Riportate lo stadio di sviluppo del progetto.
  • Fate degli screen shot
  • Se descrivete la procedura di installazione cercate di prendere in considerazione almeno un paio di distribuzioni.
  • Allegate alla recensione il programma in questione, così da renderlo disponibile direttamente per il download.


Riviste

Recensire una rivista non è cosa semplice, cambia da nuemro a numero!
Quello che bisogna fare quindi è dare l'idea di che cosa aspettarsi dalla rivista:
  • Livello di conoscenze da avere per poter comprendere e sfruttare la rivista.
  • Argomenti trattati (ad es. hardware piuttosto che grafica o Linux).
  • Se ci sono delle rubriche fisse su un argomento, la qualità e l'affidabilità della rivista.

Ricordatevi di indicare:
  • Ovviamente il titolo e la casa editrice.
  • Il costo.
  • Numero medio di pagine.
  • Se ha allegati (cd/dvd).
  • Ogni quanto esce, mensile/settimanale.

Buon lavoro !
« September 2010 »
Su Mo Tu We Th Fr Sa
1234
567891011
12131415161718
19202122232425
2627282930