Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Tryton
- Redactor técnico:
- dave
- Nombre del proyecto:
- Documentación de los módulos básicos
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
En este proyecto, propongo revisar y actualizar la documentación de los módulos básicos de Tryton. Estos son los módulos que las personas deberán activar con mayor frecuencia cuando configuren un sistema Tryton.
Las mejoras en la documentación de los módulos de Tryton ayudarán a los usuarios a encontrar los módulos adecuados para sus necesidades y, luego, a configurar y usar su sistema. Una buena documentación del módulo permitirá a los usuarios encontrar las respuestas a algunas de sus preguntas básicas sin necesidad de esperar las respuestas en el foro de debate.
Los módulos básicos incluyen, como mínimo, los siguientes: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale y stock.
Existen tres públicos principales para la documentación de Tryton: usuarios, administradores del sistema y desarrolladores. Para ayudar a segmentar la documentación para cada uno de ellos, te sugiero que la documentación de cada módulo se divida en archivos separados dentro del directorio de documentos. Estas pueden incluir archivos que contengan un índice y una descripción del módulo, instrucciones para configurarlo, información sobre cómo usarlo y detalles sobre su diseño y estructura. Según la funcionalidad del módulo, es posible que no se requieran algunos de estos archivos, y se pueden crear archivos adicionales según sea necesario. Las mejoras del módulo serán similares a las que ya propuse para el módulo de partes: https://codereview.tryton.org/297241003/#ps327231002
Estructurar la documentación de esta manera funcionará bien porque, actualmente, Sphinx la genera con archivos reStructuredText. A medida que realice cambios en la documentación, se subirán al sitio de revisión de código de Tryton para que se puedan revisar y actualizar según sea necesario. Una vez que todos estén conformes con ellas, se espera que se apruebe su inclusión en Tryton.