Documentation makes newbies more confused.

Bug #1256775 reported by Eddie Emooth
14
This bug affects 3 people
Affects Status Importance Assigned to Milestone
OpenERP Documentation
Invalid
Undecided
Unassigned

Bug Description

Unfortunately, the OpenERP 7.0 documentation is missing small bits and pieces, some important links are broken and is quite mixed up with version 6.1

Example #1
I was following this tutorial ( Example of module creation, https://doc.openerp.com/trunk/server/03_module_dev_05/ ) the other day. It asked me to follow the 20 minutes tutorial first but there is no link that takes me to the 20 minutes tutorial page. I googled and however found a link but unfortunately the link gives a 404 not found error.

Also at the end of this tutorial page, it suggests to download the travel agency module from http://apps.openerp.com/ but seriously the module doesn't exist.
.
.
.
Example #2
Last time I was trying to register a custom module on my freshly installed OpenERP system. It asked me to copy and paste the module folder into apps directory. Then it asked me to go to Settings->Modules->Update Modules List. But there was no such thing "Update Modules List". Unfortunately, Nowhere in the documentation explains how to work out. I had to enable the Technical Features for the user to be able to see "Update Modules List". The documentation doesn't say anything about it.
.
.
.
Example #3
If you go to this link (OpenERP Installation on Linux, https://doc.openerp.com/v7.0/install/linux/) and scroll down the page you will find a link to OpenERP GTK Client Installation (https://doc.openerp.com/v7.0/install/linux/client/) The URL clearly says it is for version 7.0 but if you read the content, it is mixed up with version 6.1

Surprisingly, this forum link (https://help.openerp.com/question/1047/is-a-gtk-or-desktop-client-70-available-or-planned/) says GTK Client for OpenERP 7 is officially discontinued.
.
.
.
Example #4 (Proper Documentation)
http://qt-project.org/doc/
Seriously, OpenERP people should learn from Qt Framework Documentation on how to document properly.

Eddie Emooth (eddie-5)
description: updated
Revision history for this message
Khaled Blah (khaled-blah) wrote :

I completely agree with Eddie. Especially the issue explained in example #2 cost me hours to figure out. Also, the documentation sometimes refers to screenshots (which are supposedly on the same page) but these screenshots are nowhere to be seen.

Revision history for this message
Lionel Sausin - Initiatives/Numérigraphe (ls-initiatives) wrote :

Thanks for your comments, unfortunately there is no way this kind of global critique can help.
The documentation is mostly written by volunteers who do their best, but none can proofread and improve the whole documentation on their own.
If you do want to help :
 - please file a distinct bug report for each problem, so interested people can
 - please provide a new version of the paragraph yourself, either in the bug report or -even better- as a merge proposal.

Changed in openobject-doc:
status: New → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.