Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Tryton
- Escritor técnico:
- dave
- Nombre del proyecto:
- Documentación sobre 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 los usuarios suelen necesitar activar con mayor frecuencia cuando configuran un sistema tryton.
Las mejoras en la documentación del módulo de tryton ayudarán a los usuarios a encontrar los módulos correctos para sus necesidades y, luego, los ayudarán a configurar y usar el sistema. Una buena documentación del módulo permitirá que los usuarios encuentren las respuestas a algunas de sus preguntas básicas sin tener que esperar las respuestas en el foro de debate.
Los módulos básicos incluyen, como mínimo, los siguientes módulos: account, account_invoice, account_invoice_stock, account_product, company, country, currency, Party, product, purchase, sale y stock.
Hay tres públicos principales para la documentación de tryton: usuarios, administradores del sistema y desarrolladores. Para ayudar a orientar la documentación a cada uno de ellos, te sugerimos que la documentación de cada módulo se divida en archivos separados dentro del directorio de documentos. Estos pueden incluir archivos con un índice y una descripción del módulo, instrucciones para configurar el módulo, información sobre cómo usar el módulo y detalles sobre el diseño y la estructura del módulo. Según la funcionalidad del módulo, es posible que algunos de estos archivos no sean necesarios y se puedan 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 fiesta: https://codereview.tryton.org/297241003/#ps327231002
Estructurar la documentación de esta manera funcionará bien porque Sphinx genera actualmente la documentación con archivos reStructuredText. A medida que haga cambios en la documentación, se subirán al sitio de revisión de código de tryton para que puedan revisarse y puedo actualizarlos según sea necesario. Una vez que todos estén conformes, podrán recibir la aprobación de su inclusión en tryton.