← Back to team overview

openerp-expert-framework team mailing list archive

Re: We NEED modules documentation

 

Hi Ferdinand,

Ferdinand Gassauer wrote:
> Am Dienstag 08 Dezember 2009 20:36:55 schrieb Simone Orsi:
>> Simone Orsi wrote:
>>> Hi all,
>>>
>>> as almost every open-source project we lack of docs.
>>>
>>> The subject of this message "modules documentation" hence I will not
>>> talk about the reference manual (http://doc.openerp.com/developer/)
>>> which everybody knows it sucks...
>>> BTW: I'd prefers something like http://docs.repoze.org/bfg/1.2/ ...this
>>> is a *real* doc.
>>> But let's talk about that in a separate discussion.
>>>
>>>
>>> IMHO we *need* docs for modules' purpose and for modules' usage.
>>>
>>> I think all of us, noobs above all, spend (better, waste) too much time
>>> in searching and asking for the right module for this or that purpose.
>>> Even for people who want to approach OE this can be very very harmful.
>>>
>>> I think it would be nice to have a simple README.txt or HOW-TO.txt or
>>> whatever inside the module which tells you what the module does and how
>>> to get started with it.
>>>
>>> Also, the content of the *.txt should be placed into
>>> http://doc.openerp.com/technical_guide/ or into a nicer list of modules.
>>>
>>> Cheers
>> Here's a draft:
>>
>> https://docs.google.com/Doc?docid=0ASJ1qTbr6NdMZG1oanhkN18wY3BncnJ0ZnE&hl=e
>> n
>>
> It seems it's not editable

It should be editable for logged-in users. Can you re-try?

-- 
Simone Orsi              simone.orsi<at>domsense.com
Via Alliaudi, 19 - 10064  -  Pinerolo (TO)  -  Italy
Mobile: (+39) 3475004046  -   Fax: (+39) 01214469718
Domsense Srl                 http://www.domsense.com



References