Community mailing list archives

community@mail.odoo.com

Re: Reflection about documentation.

by
Hertford Developments Limited, Kurt Haselwimmer
- 08/13/2014 14:02:35
David,

I would be happy to give feedback on what has been created from the perspective of a newcomer. As a newcomer I am not in a position to write an outline for the documentation of a product that I am unfamiliar with. I would suggest that if you want to base a structure for your documentation on something you should look at the index in Greg Moss's excellent book on v7 - I am sure you are all familiar with it.

regards

Kurt


Kurt, I suggest, you set up a Google Docs, where all willing to join you can give editing rights, to set up and discuss a basci outline. I personally like the anisble structure, but we certainly also have to think about metastructures of a documentation, such as technical glossary (which would be api and model reference), but also a functinoal glossara, maybe which renders the help="" tags of all fields in a strucutred manner (automatically) and aditunally adds some curated entries about generla odoo, talk... Well let's do this discussions on a working document...


El Alemán S.A.S

David Arnold BA HSG / Gerente
315 304 13 68/ david²elaleman.co

El Alemán S.A.S Office: +57 (1) 651 3766 / Fax: +57 (1) 651 3772 
CRA 13 93 40 P4, Bogotá, Colombia
http://www.elaleman.co

Facebook

This e-mail message may contain confidential or legally privileged information and is intended only for the use of the intended recipient(s). Any unauthorized disclosure, dissemination, distribution, copying or the taking of any action in reliance on the information herein is prohibited. E-mails are not secure and cannot be guaranteed to be error free as they can be intercepted, amended, or contain viruses. Anyone who communicates with us by e-mail is deemed to have accepted these risks. El Aleman S.A.S is not responsible for errors or omissions in this message and denies any responsibility for any damage arising from the use of e-mail. Any opinion and other statement contained in this message and any attachment are solely those of the author and do not necessarily represent those of the company.



2014-08-13 12:29 GMT-05:00 Fabien Pinckaers <fp@odoo.com>:
> In this point, is good have all methods on the orm documented (it is a
> layer) and the external is the "how to helper guide", right?
> 
> IMHO a PR to the core fixing doc desn't bring too much problem, but I
> think all the api's:
> 
> openerp/
> web/
> mail/
> website/
> 
> __must__ be related to the code.

The problem is that it's a huge overhead to do a pull request just to
fix a typo. It has to be super easy for documentation writers to
contribute. We need to support the "Edit in Github" button.



-- 
Fabien Pinckaers
Odoo Founder

Phone: +32.81.81.37.00
Web: https://www.odoo.com
Twitter: @fpodoo

Instant Demo: https://odoo.com/start

_______________________________________________
Mailing-List: https://www.odoo.com/groups/community-59
Post to: mailto:community@mail.odoo.com
Unsubscribe: https://www.odoo.com/groups?unsubscribe


_______________________________________________
Mailing-List: https://www.odoo.com/groups/community-59
Post to: mailto:community@mail.odoo.com
Unsubscribe: https://www.odoo.com/groups?unsubscribe