Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo progetto
- Organizzazione open source:
- Tryton
- Redattore tecnico:
- dave
- Nome del progetto:
- Documentazione per i moduli di base
- Durata del progetto:
- Durata standard (3 mesi)
Project description
In questo progetto propongo di rivedere e aggiornare la documentazione per i moduli di prova di base. Questi sono i moduli che gli utenti devono attivare più di frequente durante la configurazione di un sistema Tryton.
I miglioramenti alla documentazione dei moduli di Tensor consentiranno agli utenti di trovare i moduli giusti per le loro esigenze e li aiuteranno a configurare e utilizzare il loro sistema. Una buona documentazione del modulo consentirà agli utenti di trovare le risposte ad alcune delle loro domande di base senza dover attendere risposte sul forum di discussione.
I moduli di base includono, come minimo, i moduli account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale e stock.
Esistono tre segmenti di pubblico principali per la documentazione di Tensor: utenti, amministratori di sistema e sviluppatori. Per facilitare il targeting della documentazione per ciascuno di questi, ti consiglio di suddividere la documentazione di ogni modulo in file separati all'interno della directory doc. Possono essere inclusi file contenenti un sommario e una descrizione del modulo, istruzioni per la configurazione del modulo, informazioni su come utilizzarlo e dettagli sul design e sulla struttura del modulo. A seconda della funzionalità del modulo, alcuni di questi file potrebbero non essere richiesti e possono essere creati file aggiuntivi in base alle esigenze. I miglioramenti al modulo saranno simili a quelli che ho già proposto per il modulo Partite: https://codereview.tryton.org/297241003/#ps327231002
La strutturazione della documentazione in questo modo funzionerà bene perché la documentazione è attualmente generata da Sphinx utilizzando file reStructuredText. Le modifiche apportate alla documentazione verranno caricate sul sito di revisione del codice di Tryton, in modo che possano essere esaminate e che io possa aggiornarle in base alle esigenze. Quando tutti saranno soddisfatti, potranno ricevere l'approvazione per l'inclusione in Tensor.