> Il giorno 26/gen/2015, alle ore 09:50, Alessandro <dedalus2...@gmail.com> ha > scritto: > > Il 01/25/2015 10:46 AM, Giovanni Porcari ha scritto: >> Inoltre alle persone che mi hanno contattato in privato, oltre a dare >> consigli >> su installazione e modo di procedere, ho dato i nostri contatto skype e la >> disponibilità >> a rispondere in immediato ai vari dubbi che potessero avere. > ... >> io ne aiuto direttamente alcuni e poi loro potranno auspicabilmente >> scrivere quello che hanno capito e formare una documentazione cooperativa >> e aggiornata. > > Una volta che avrò imparato a utilizzare Genropy (*) mi porrò il problema di > come rendere il favore e pubblicare un po' di documentazione. > E in quel momento avrò un altro problema: dove? Inoltre la mia conoscenza > sarà comunque parziale: potrò documentare meglio solo ciò che avrò usato. > > In pratica avrò due strade: > - scrivere qualcosa sul mio blog, tipo "Starting with Genropy in few steps" > (già, ancora non ho un blog. Ma c'e' tempo..) > - aggiungere un tassello ad una documentazione già esistente >
Come ho già detto il problema della documentazione è il fatto che DEVE essere perfetta. Una cattiva documentazione è come una segnaletica stradale sbagliata: ti segnala curva pericolosa a destra è invece ti trovi un dosso con curva a gomito a sinistra. Noi abbiamo avuto con noi (e regolarmente retribuito) una persona incaricata di scrivere la documentazione (ovviamente tempestandoci di domande e lavorando gomito a gomito). Purtroppo dopo circa 1 anno la persona in questione ha scoperto la sua vocazione per l'insegnamento e ci ha abbandonato. C'era poi, come ho detto prima il nostro amico Jeff Edwards che si occupava della documentazione e della traduzione in inglese ma dopo la sua scomparsa (che ci ha anche molto colpito e rattristato), non siamo riusciti a trovare chi potesse raccogliere il lavoro. Ovviamente chiunque desiderasse partecipare al progetto di genropy è graditissimo e riceverebbe da noi tutto l'appoggio, l'aiuto e le spiegazioni necessarie a minimizzare la sua fatica e ad avere i migliori risultati. > Questa seconda strada ci aiuterebbe, e infatti vedo che hanno già consigliato > un servizio tipo "https://readthedocs.org/"; . Mai utilizzato, ma il concetto > che volevo esprimere è quello. > > Alessandro > > (*) E' da tempo che ho scaricato Genropy, ma l'unico file che ho letto in > questi anni -sigh!- era privo di docstring e commenti, e per questo al Pycon5 > vi chiesi cortesemente di aggiungere un qualsiasi tipo di documentazione (eh, > vedo che è un argomento nuovo per voi). Mi sono successivamente reso conto di > aver letto l'unico file senza commenti.. chiedo venia :-) > > Beh non avremo i migliori commenti del mondo ma un file senza commenti per fortuna è abbastanza una rarità (oppure è autodocumentante) Ciao G _______________________________________________ Python mailing list Python@lists.python.it http://lists.python.it/mailman/listinfo/python
