Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Tryton
- Rédacteur technique:
- dave
- Nom du projet:
- Documentation pour les modules de base
- Durée du projet:
- Durée standard (3 mois)
Project description
Dans ce projet, je vous propose d'examiner et de mettre à jour la documentation relative aux 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 sur les modules permettra aux utilisateurs de trouver les réponses à certaines de leurs questions de base sans avoir à attendre les réponses sur le forum de discussion.
Les modules de base comprennent au minimum les modules suivants: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale et stock.
Il existe trois audiences principales pour la documentation de tryton : les utilisateurs, les administrateurs système et les développeurs. Pour cibler la documentation sur chacun d'entre eux, je vous suggère de diviser la documentation de chaque module en fichiers distincts dans le répertoire doc. Ces fichiers peuvent inclure une table des matières, une description du module, des instructions de configuration, des informations sur son utilisation, ainsi que des détails sur la conception et la structure du module. Selon les fonctionnalités du module, certains de ces fichiers ne seront peut-être pas nécessaires et des fichiers supplémentaires peuvent être créés si nécessaire. Les améliorations du module s'apparenteront à celles que j'ai déjà proposées pour le module "party" : https://codereview.tryton.org/297241003/#ps327231002
Structurer la documentation de cette manière fonctionnera bien, car elle est actuellement générée par Sphinx à l'aide de fichiers reStructuredText. Au fur et à mesure que je modifie la documentation, elles seront importées sur le site de revue de code de tryton afin qu'elles puissent être examinées et mises à jour si nécessaire. Une fois que tout le monde est satisfait d'eux, ils peuvent alors, avec un peu de chance, être autorisés à faire partie de l'équipe de tryton.