Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Provat
- Technical writer:
- dave
- Nome 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 dei moduli di base di Trion. Si tratta dei moduli che le persone hanno più comunemente bisogno di attivare quando configurano un sistematryton.
I miglioramenti apportati alla documentazione dei moduli di prova aiuteranno gli utenti a trovare i moduli più adatti alle proprie esigenze e a configurare e utilizzare il sistema. Una buona documentazione dei moduli consentirà agli utenti di trovare le risposte ad alcune delle loro domande di base senza dover aspettare le risposte nel forum di discussione.
I moduli di base includono almeno i seguenti moduli: account, account_invoice, account_invoice_stock, account_product, azienda, paese, valuta, parte, prodotto, acquisto, vendita e azioni.
Esistono tre tipi di pubblico principali per la documentazione di Triton: utenti, amministratori di sistema e sviluppatori. Per indirizzare la documentazione a ciascuno di questi elementi, suggerisco di suddividere la documentazione di ogni modulo in file separati all'interno della directory doc. Questi file possono includere file contenenti un sommario e una descrizione del modulo, istruzioni per impostare il modulo, informazioni su come utilizzare il modulo e dettagli sul design e sulla struttura del modulo. A seconda della funzionalità del modulo, alcuni di questi file potrebbero non essere necessari e puoi creare altri file in base alle necessità. I miglioramenti del modulo saranno sulla linea di quelli che ho già proposto per il modulo del partito: https://codereview.tryton.org/297241003/#ps327231002
La strutturazione della documentazione come questa funzionerà bene perché la documentazione è attualmente generata da Sphinx utilizzando file reStructuredText. Man mano che apporto modifiche alla documentazione, queste vengono caricate sul sito di revisione del codice di Createton, in modo da poterle esaminare e, se necessario, aggiornarle. Una volta che tutti sono soddisfatti del risultato, si spera che possano ricevere l'approvazione per l'inclusione in Riprova.