[ninux-dev] Fwd: [Nodeshot] Documentation (work in progress)

[nemesis]

 Volevo mostrarvi lo strumento che sto sando per la documentazione di 
 nodeshot:

 http://nodeshot.readthedocs.org/en/latest/

 Dovremmo cercare di documentare il più possibile quello che facciamo.

 Ho deciso che comincerò a documentare quello che faccio MENTRE scrivo 
 il codice, così come ho fatto con gli unit test.

 Gli unit test mi stanno aiutando moltissimo quando riscrivo parti 
 dell'applicazione cercando di migliorare il codice, perchè quando cambio 
 le cose sgamo subito i bug e così sono sicuro che anche dopo che cambio 
 parecchia roba le funzionalità critiche continuano a funzionare.

 Scrivere la documentazione mentre scrivo il codice mi aiuterà a non 
 dimenticare perchè ho fatto certe scelte piuttosto che altre. Mi è già 
 successo con alcune parti che ho scritto diversi mesi fa.. già mi sono 
 scordato qualcosa e ci metto un pò a ricordare.

 Ovviamente questo avrà conseguenze positive anche per gli altri, in 
 primis una buona documentazione permetterà ad altri di partecipare.

 Quindi la mia è un esortazione ed un auto critica a migliorare 
 documentazione e testing automatizzato di quello che facciamo.

 Se non lo facciamo stiamo semplicemente cazzeggiando, perchè quello che 
 facciamo non potrà essere utilizzato da altri.

 Federico


 -------- Original Message --------
 Subject: [Nodeshot] Documentation (work in progress)
 Date: Wed, 27 Nov 2013 18:12:08 +0100
 From: nemesis <nemesis at ninux.org>
 To: <nodeshot at ml.ninux.org>
 Reply-To: Nodeshot <nodeshot at ml.ninux.org>

 Grab it here:

 http://nodeshot.readthedocs.org/en/latest/

 If you wanna help you could try the install procedure and see if 
 there's any issue.. I've been working often on it latelly.

 Docs are made with sphinx, source files are contained here:
 https://github.com/nemesisdesign/nodeshot/tree/refactoring/docs

 Nemesis
 _______________________________________________
 Nodeshot mailing list
 Nodeshot at ml.ninux.org
 http://ml.ninux.org/mailman/listinfo/nodeshot