The documentation, right now, is a bit dry:
It explains only what fields are, but not how the workflow of the module works.
For example the account module:
It explain quite well the schema of each view the user can encounter, but it lacks how the accounting workflow is implemented in tryton. Wee need an “overview” section in each module. It should just describe how each view/schema interact with each other, without going to much in the details.
Something like this can be very helpfull:
The main task of the accounting module is to define the company Chart of account (via a template or manually created by the user) and keep track of accounting move divided by Fiscal year. […]
This give a short overview on how the module works, and give some context on all module keyword (like fiscal year, chart of account, ecc…)
Another important aspect is what are the step required by the user to make a bare bone configuration. So a " Getting started" section should be added to the documentation. For example in the account module, you can have something like this:
Before you can create an accounting move, you should define a fiscal year. In the fiscal year you can define periods and configure the auto numbering rule for each accounting move[…]
This kind of documentation is direct, short and relatively easy to maintain because it describe how the workflow is implemented (rarely change), and not how to do things (something that can change on each release).
Another point is that we can gradually document the modules: we don’t need to “carpet documenting” all the things, but we can start slowly as a code review rule for new module (for example).