Community mailing list archives
Re: Guidelines for User Documentationby
Thank you to all who have starting writing or reviewing the new user documentation for future version 9 (initial announcement). Everything seems to start well.
Here is a few reminders for those who would like to jump in:
Check the spreadsheet at https://odoo.com/r/user-doc . We have increased the table of content with more subjects. Don't hesitate to take free slots as writers or reviewers if you are confident in one subject.
If you are creating a new Google Docs sheet, don't forget to allow users to put comments for the review.
If you are afraid of the blank page or don't know where to start, do not hesitate to reuse content. The v7 documentation is probably a good start. Sometimes a bit outdated or not perfect but still a lot of valid information. You can also take example on the assets management page (published version).
If you need to test some features or needs to take new screenshots (to do with the new design), please use one of the following link:
Runbot master with new design (from development enterprise branch)
Runbot master enterprise (in which the new design will be merged soon, latest features)
Runbot master community (same as above, minus enterprise modules)
Keep in mind that these branches are still in heavy development, features may be broken from time to time so if something stops working, check a bit later to see if it has been fixed (you can ping me if the feature you are documenting stops working and isn't fixed after a few days).
Once both the writing and reviewed are done, we (probably xml or myself) will convert the pages to RST to push to GitHub (don't hesitate to ping me, if we miss one reviewed page). Once this is done, the whole edition work will be switched to GitHub, so this will be the place for further updates.
If you notice an error, typo or need for rewriting some parts of already published pages, please report an issue or, even better if you can, submit a correction to the existing files (we will add buttons to make that easier from published documentation).
The documentation is build nightly so don't worry if your changes are not automatically published.
Last but not least, if you are not sure where or how to start, please join our online kick-off meeting this Monday July 20 at 16.30 CET (Brussels time) (or in other timezones)
On G+: https://plus.google.com/events/cl05qo8r3aq9f91vo38gu0p307c
On Youtube: http://www.youtube.com/watch?v=B00X2T-vZ0M
-- Martin Trigaux Odoo (Formerly OpenERP) https://odoo.com https://github.com/mart-e