Módulo Documentation
A lo largo del artículo se hablará sobre diferentes aspectos del módulo documentation.
Sin embargo, también se introduce la ayuda contextual, lo que significa que dependiendo de la vista e incluso campo sobre el que se requiera ayuda, se mostrará uno u otro párrafo.
Así, en el cliente Koo se mostrará un botón ayuda en la parte inferior, y también, al estilo de los campos que tienen un tip de ayuda, se podrá ver un interrogante azul, indicando que hay documentación disponible sobre el campo en cuestión.
En cuanto a los aspectos técnicos, utiliza Sphinx como base. Al cual, se han añadido algunas extensiones a la sintaxis. De forma que se pueda especificar el nombre del campo o el nombre completo de un menú.
Aislandonos así, de futuros cambios en la nomenclatura, o bien la generación automática de capturas de pantalla de las vistas.
Cada módulo provee su propia documentación en un directorio, junto con el código, y si aporta documentación sobre otros módulos, también puede incluirla, de forma que aunque no se tenga acceso al módulo product, se puede ofrecer ayuda sobre él.
Referencias
- Hilo en la lista de correo OpenERP-Spain de Google: http://groups.google.com/group/openerp-spain/browse_thread/thread/2cfe1d960892aeec
- Post de presentación en el blog de NaN: http://albert-nan.blogspot.com/2010/08/documentation-users-and-contributors.html
- Post con documentación en el blog de NaN: http://albert-nan.blogspot.com/2010/08/new-documentation-module-aims-to-be.html
Además, le dejamos el enlace a nuestra web a continuación donde podrá enconctrar más infromacciópn relacionada con el modulo documentation, haciendo clic aquí.
