Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Tryton
- Rédacteur technique:
- dave
- Nom du projet:
- Documentation des modules de base
- Durée du projet:
- Durée standard (trois mois)
Project description
Dans ce projet, je propose d'examiner et de mettre à jour la documentation des modules de base de Tryton. Il s'agit des modules que les utilisateurs doivent le plus souvent activer lors de la configuration d'un système Tryton.
Les améliorations apportées à la documentation des modules de Tryton aideront les utilisateurs à trouver les modules adaptés à leurs besoins, puis à configurer et à utiliser leur système. Une bonne documentation du module permettra aux utilisateurs de trouver les réponses à certaines de leurs questions de base sans avoir à attendre des réponses sur le forum de discussion.
Les modules de base incluent au minimum les modules account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale et stock.
La documentation Tryton s'adresse à trois audiences principales : les utilisateurs, les administrateurs système et les développeurs. Pour cibler la documentation sur chacun d'eux, je suggère de diviser la documentation de chaque module en fichiers distincts dans le répertoire de documentation. Il peut s'agir de fichiers contenant une table des matières et une description du module, des instructions de configuration, des informations sur l'utilisation du module, ainsi que des détails sur sa conception et sa structure. Selon la fonctionnalité du module, certains de ces fichiers peuvent ne pas être nécessaires, et des fichiers supplémentaires peuvent être créés si nécessaire. Les améliorations apportées au module seront semblables à celles que j'ai déjà proposées pour le module de parti: https://codereview.tryton.org/297241003/#ps327231002
Cette structuration de la documentation est une bonne solution, car elle est actuellement générée par Sphinx à l'aide de fichiers reStructuredText. Lorsque j'apporterai des modifications à la documentation, elles seront importées sur le site d'examen du code Tryton afin qu'elles puissent être examinées et que je puisse les mettre à jour si nécessaire. Une fois que tout le monde sera satisfait, ils pourront être approuvés pour être inclus dans Tryton.