OpenERP Spain - Portal web sobre OpenERP en España

 
Está aquí: Inicio

Módulo Documentation

Introducción

Es de sobra conocido que uno de los mayores problemas del software, y más del software libre, es la documentación, y lamentablemente, OpenERP no es una excepción.

Sin embargo, NaN ha presentado un módulo que pretende salvar esta brecha, y además teniendo en mente los puntos de vista de los distintos actores que intervienen en la realización y posterior consumo de la documentación, cuyas principales inquietudes son:

  • Usuarios: Necesitan la documentación de forma que pueda resolverles tanto una duda puntual sobre un campo en concreto, mientras usan la aplicación; o bien como un libro, de forma que pueda ser consultada sin necesidad de estar en frente del sistema.
  • Desarrolladores: Odian la documentación para el usuario, basándose en la idea de que los usuarios no la van a utilizar, así que hay que ponérselo fácil para redactar la ayuda, ya que suelen ser los mismos que la construyen.
  • Escritores y traductores: Necesitarán sistemas para actualizar las capturas de pantalla de forma automatizada, y que les aislen de cambios en otros módulos o funcionalidades de OpenERP.

Cómo funciona

La mala noticia es que en estos momentos, y al ser un producto de NaN, se han centrado en el cliente Koo, de forma que ciertas funcionalidades no están disponibles todavía para el cliente web o GTK.

modulo_documentation

El módulo genera documentación en HTML o PDF cuando se solicita la ayuda completa, en forma de libro, desde la opción de menú Ayuda | Documentación.

 

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.

modulo_documentation_contextual

En cuanto a los aspectos técnicos, utiliza Sphinx como base, al que 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 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