A Dimarts, 15 de desembre de 2009, Cloves Almeida va escriure: > My 2c: > > Developers know and like stuff like wiki, code comments and READMEs. > With discipline, these should be enough. With no discipline, no system > will work. > > Business people and Developers all understand process/workflows - it's > business lingua franca. Almost everyone understand a flowchart, they are > easy to build and, if well done, makes terrific specifications. I advise > everyone to learn BPMN > (http://en.wikipedia.org/wiki/Business_Process_Modeling_Notation). > > The business documentation would be describing a process step. Eg.: > imagine the "Choose shipping and invoicing method" step in "Encoding a > sales order" process. You could write a description detailing each > option, what it does and the description. The field popup could link > where in the process the field is used, set or evaluated. Much could be > automated.
I fully agree with Cloves. For me the conclusion is that the new documentation framework should be used to solve "User" and "Company", but won't probably be used for developers doc. I think what we need now is to create a basic documetation system that just works. We could later add many improvements as the one suggested by Cloves. Another easy to implement idea would be to add a <workflow name="workflow_name"/> tag that would automatically render an image with the given workflow, for example. > Bonus stuff is that 80% of ISO 9000 documentation work is done ;) > > Joël Grand-Guillaume escreveu: > > Hi All ! > > > > > > First, thanks for the initiative !! This is an important point on > > OpenERP : Docs... I'm impressed by your proof of concept Albert, it's > > well done ! > > > > But I'm asking my-self about the last Ferdinand post: > >> Just do not forget it - IMHO we need a "complete" doc system usable > >> for all > >> kind of documentation (developer, application designer, site, > >> company, user) > > > > Does it really exists ? I mean, you think we can find something good > > for both devs people and end users ? They have different needs, and > > I'm sceptic about only one solution... > > > > We clearly have those kind of docs: > > > > - Developper : Technical things and comments > > > > - User : How to use the software and do the configuration. Understand > > the purpose > > > > - Company : procedure specific on how to use OpenERP in the company > > > > If I think we can provide something with this solution for User docs > > and this is good ! But this mainly cause we know well enough OpenERP > > to make this doc. > > > > Developer docs id probably better into README.txt files.. As developer > > don't really like to write docs ;) ! > > > > Company docs may use this also if we can provide an easy way to write > > and link doc page to the right place... > > > > So, my conclusion is that it's a really good idea an proof of concept, > > just may be not for Devs docs. For company doc, we need something as > > simple as possible. > > > > Thanks for the work again ! > > > > My 2 cents, > > > > > > > > > > *Joël Grand-Guillaume** * > > > > *OpenERP Consultant* > > *Business Solutions* > > * > > * > > *Camptocamp SA* > > PSE A, CH-1015 Lausanne > > > > www.camptocamp.com <http://www.camptocamp.com> > > > > > > Phone: +41 21 619 10 28 > > Office: +41 21 619 10 10 > > Fax: +41 21 619 10 00 > > Email: [email protected] > > <mailto:[email protected]> > > http://www.camptocamp.com/fr/business-solutions/formations > > > > ------------------------------------------------------------------------ > > > > _______________________________________________ > > Mailing list: https://launchpad.net/~openerp-expert-framework > > Post to : [email protected] > > Unsubscribe : https://launchpad.net/~openerp-expert-framework > > More help : https://help.launchpad.net/ListHelp > > _______________________________________________ > Mailing list: https://launchpad.net/~openerp-expert-framework > Post to : [email protected] > Unsubscribe : https://launchpad.net/~openerp-expert-framework > More help : https://help.launchpad.net/ListHelp > -- Albert Cervera i Areny http://www.NaN-tic.com Mòbil: +34 669 40 40 18 _______________________________________________ Mailing list: https://launchpad.net/~openerp-expert-framework Post to : [email protected] Unsubscribe : https://launchpad.net/~openerp-expert-framework More help : https://help.launchpad.net/ListHelp
