openerp-expert-framework team mailing list archive

[Carlos Liébana <carlos.liebana@xxxxxxx>]

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?

 

Best regards.

 

Fuente: Nabble - openerp-expert-framework
Expuesto el: viernes, 27 de agosto de 2010 20:34
Autor: Albert Cervera i Areny
Asunto: Re: New documentation module released

 


A Divendres, 27 d'agost de 2010, Albert Cervera i Areny va escriure:

> We have just published the new documentation module that was discussed some

> months ago in this list. Things have evolved quite a bit from my original

> idea of using docbook, but I think we got something that is good for

> everyone.

> 

> The system uses sphinx, it can generate HTML and PDF documentation on a

> per- user basis, can create screenshots automatically, allows linking to

> the docs from fields, views and menu entries in the application, it's easy

> to translate by using .po files and it is extensible.

> 

> The module can be found in extra-addons/5.0 and is called, well..

> 'documentation'. I have just made a blog post explaining what are the

> issues the module solves [1] and expect to have documentation, screenshots

> and examples of how it works by Monday. Will notify the list by then.

> 

> I know some have already started looking at it and we're open to your

> feedback. We think this should become the documentation framework of

> OpenERP and we hope openerp sa will take a look at it and join the effort.

> 

> [1] http://ves.cat/ai5r

I have just published the post I mentioned [1]. It's a bit long, but hopefully it provides a good overview of what you can expect of it. Even if it's in Spanish, I attach a modules directory you can copy to 'documentation/doc' to see how things feel with 'real' documentation. The zip is 1 Mb because it contains images, but I wanted to show you how they can be added too.

Again, comments are welcomed.

[1] http://ves.cat/ai6P


-- 

Albert Cervera i Areny

 <http://www.NaN-tic.com?by-user=t> http://www.NaN-tic.com

 <http://www.NaN-tic.com?by-user=t> OpenERP Partners

Mòbil: +34 669 40 40 18

 <http://twitter.com/albertnan> http://twitter.com/albertnan 

 <http://albert-nan.blogspot.com?by-user=t> http://albert-nan.blogspot.com 



_______________________________________________ 
Mailing list: https://launchpad.net/~openerp-expert-framework
Post to     : [hidden <http://feeds.feedburner.com/user/SendEmail.jtp?type=node&node=1378651&i=0>  email] 
Unsubscribe : https://launchpad.net/~openerp-expert-framework
More help   : https://help.launchpad.net/ListHelp


  <http://feeds.feedburner.com/images/icon_attachment.gif> modules.zip (1M) Download Attachment <http://feeds.feedburner.com/attachment/1378651/0/modules.zip> 


Ver <http://openerp-expert-framework.71550.n3.nabble.com/New-documentation-module-released-tp1369744p1378651.html>  artículo...