Table of Contents

Idee per contribuire al wiki SlackDocs

Contribuire con della documentazione può essere un lavoro molto piacevole e gratificante, ma molti utenti sono spaventati dall'idea di dover scrivere documentazione. L'idea dietro al wiki non è quella di creare documentazione perfetta, ma quella di invogliare la community a dare piccoli contributi che sommati portino ad un risultato finale. Quindi, non è necessario sentirsi agitati da ciò.

Ogni utente può decidere in quale argomento dare il suo contributo. Ci sono molte aree specifiche in cui ognuno di voi può pensare di avere le competenze necessarie.

Modifica, Espandi, Migliora

Modificare, espandere e migliorare può essere un ottimo inizio per contribuire a creare documentazione in stile wiki. Iniziando un progetto collaborativo, ogni aggiunta o correzione è benvenuta.

Come collaboratore, non pensare che modificare e correggere sia parte marginale del lavoro: anzi, è una delle parti fondamentali del wiki, esattamente quanto l'aggiunta di nuovi articoli.

Consigli per la scrittura

Quando diventerai pratico nello scrivere per il wiki, ecco alcuni suggerimenti in ordine sparso per migliorare i tuoi contributi:

HOWTO/Tutorial tecnici

HOWTO tecnici, riguardanti compiti specifici, sono molto apprezzati nella community Linux. Gli HOWTO tecnici sono focalizzati nell'esecuzione di determinati compiti e nel come devono essere svolti, passo dopo passo, con illustrazioni e spiegazioni dettagliate. La maggior parte degli HOWTO è improntata verso compiti ben precisi, per cui spesso forniscono esempi di codice ove necessario. Note ed avvertimenti svolgono un ruolo importantissimo nel non far incorrere il lettore in potenziali errori, anche gravi.

Alcuni esempi di HOWTO possono essere:

e via discorrendo.

Programmi o applicazioni specifici

Si tratta di brevi articoli informativi su specifici programmi o applicazioni. Tenete a mente che questi argomenti non devono sostituire le pagine di mam. Tuttavia possono fornire informazioni sufficienti agli gli utenti per iniziare ad usarli e per trattare aspetti particolari che possono richiedere risposte.

Questi potrebbero includere argomenti riguardanti applicativi desktop o sulla gestione di pacchetti, per esempio.

Articoli generici

sono articoli che non si focalizzano su specifici argomenti, ma su tematiche di più ampio respiro. Un articolo generico non richiede un know-how specifico, ma può essere espanso con collegamenti verso articoli o fonti correlati e più specifici.

Un esempio di articolo generico è quello sulla Filosofia di Slackware .

Argomenti da trattare

La seguente lista è basata sul suggerimento di Woodsman. Può essere utile come guida per iniziare a pubblicare articoli sul wiki.

Argomenti non accettabili

Anche se il wiki da molta libertà ai suoi contributori, ci sono alcuni argomenti che non sono accettati. Alcuni di questi possono essere:

I potenziali collaboratori devono anche controllare che l'articolo che stanno per scrivere non esista già (o che non ne esista uno molto simile). Evitare il raddoppiare degli sforzi è nello spirito del wiki.

Fonti