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 propose d'examiner et de mettre à jour la documentation concernant les modules tryton de base. 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 des 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 incluent 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 tryton : les utilisateurs, les administrateurs système et les développeurs. Pour vous aider à cibler la documentation sur chacun d'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 et une description du module, des instructions de configuration, des informations sur son utilisation et des détails sur sa conception et sa structure. Selon les fonctionnalités du module, certains de ces fichiers peuvent ne pas être requis 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 de la fête: 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. À mesure que je modifie la documentation, elles sont importées sur le site de révision de code de tryton. Elles peuvent donc être examinées et mises à jour si nécessaire. Une fois que tout le monde en est satisfait, elle peut, espérons-le, être approuvée pour faire partie de la liste de essayage.