openerp-expert-framework team mailing list archive

["Borja López Soilán (Pexego)" <borjals@xxxxxxxxx>]

Carlos Liébana wrote:
> Hi,
>
>  
>
> As I pointed out here http://www.openobject.com/forum/topic17936.html 
> , I think this module is really interesting, and that it’s getting 
> absolutely no feedback from nobody.
>
>  
>
> To fetch the documentation, it’s really needed to have a new standard 
> folder (doc) in each addon module (but only OpenERP SA has rights to 
> commit to the official ones), but the effort it’s really worth, from 
> my point of view. A good and easy help system is a “must” and 
> decreases some of the first level (pure functional, of course) support 
> questions from the users.
>
>  
>
> What do you think?


I like the idea of having the documentation embedded on OpenERP's 
modules and accessible from either the OpenERP clients or as a html/pdf 
book. Its easier for developers and its nicer to users:

   * A 'book'-like help, like the current OpenERP manual, works well
     for newbies that want to go from A to Z. But we know most users
     won't do that. Contextual help works better for (self-considered)
     non-newbies that just want to check "what is supposed that button
     to do" or "does this field mean this".

   * Currently there is a big distance between the source and the
     documentation, developers have to download a different Bazaar
     branch for the documentation, then they have to find the right
     place for the documentation of the new module, maybe editing the
     surrounding documentation to blend it... how many (of us) have
     done it? anybody raising hands?
     Being able of just creating a "doc" folder inside each module,
     makes it a lot easier and inviting to write documentation for
     small modules.

   * Another problem of the current book-like or 'fixed' documentation,
     is that the current documentation might not reflect what the user
     sees. For example, the payment process may be completely different
     from what is documented if you have the account_payment_extension
     module. This happens a lot with localizations.
     Example: in Spain using several sequences for the accounting
     journals is not right, so on the Spanish localization we would
     like to be able to 'overwrite' the default help text of the
     "sequences per journal" checkbox-field to add a comment like "On
     Spain only one sequence should be used for all the journals".
     Having a documentation framework like the proposed would allow
     just that! Even more, the idea can be further extended to allow
     full inheritance (having extension points on the documentation),
     extending or overwriting the previous documentation on each new
     module. After all, easy inheritance of existing modules has been
     the best OpenObject framework feature so far.


But I wonder... can the existing documentation be ported to a system 
like this? (I mean, does the copyright/license allow it?), would it 
complex to add support for this on the GTK and web clients?

Best regards.

--
Borja López Soilán
borjals@xxxxxxxxx

Pexego Sistemas Informáticos S.L.
Avenida de Magoi 66 - 27002 Lugo (España)
Tel./Fax 982801517
http://www.pexego.es 


AVISO LEGAL - CLÁUSULA DE PRIVACIDAD
Este mensaje se dirige exclusivamente a su destinatario y puede contener información privilegiada o confidencial. Si no es usted el destinatario indicado, queda informado de que la utilización, divulgación y/o copia sin autorización está prohibida en virtud de la legislación vigente. Si ha recibido este mensaje por error, le rogamos que nos lo comunique inmediatamente por esta misma vía y proceda a su destrucción.