1. Mailing Lists
  2. Contributors
  3. Re: "The plan" to help non technical to contribute documentation on OCA modules

Contributors mailing list archives

contributors@odoo-community.org

Browse archives

Re: "The plan" to help non technical to contribute documentation on OCA modules

Re: "The plan" to help non technical to contribute documentation on OCA modules

Avatar

Re: "The plan" to help non technical to contribute documentation on OCA modules

by
MetricWise, Inc., Adam Heinz
- 18/12/2024 14:13:30
We've attempted to go this route ourselves, but have struggled to make our less technical users self-sufficient in tour creation. Is recording tours a new feature of a recent version of Odoo?

On Wed, Dec 18, 2024 at 6:13 AM Graeme Gellatly <notifications@odoo-community.org> wrote:
For me the fastest way to document most OCA modules AND have them apply across versions AND have them always current is to use tours which can now simply be recorded, exported, played and could apply per version, I am asking my team to do that for everything now. It not only has the benefit of allowing the user a guided how to of how to use the module, but it also becomes a test across versions and actually makes reviewing PR's easier. IOW, your documentation (tour in this case) becomes part of your test suite. Your test suite becomes part of documentation. Because every version would have its own tour, then you just need to click the version in whatever service/website. You can link whatever version to runboat to try the tour.

Reference