Documentation Enhancements

[anassahmed]

Hello,

We're an Odoo partner in Egypt, and we'd like to contribute to the documentation here.

We've some suggestions to enhance the quality of documentation:

1. Specify Odoo version on new feature sections. Check Python Documentation under the end of section.
2. Split each module by category (End User, Implementation, Administration). Check Oracle Documentation and Gitlab Documentation as references.
3. Please open translation for Arabic (Egypt) language on Transifex.

We're awaiting your feedback. We want to unify the way we write documentation so we can benefit from the shared codebase.

Thanks.

[anassahmed]

@abdallamhafeez Follow the issue here.

[rim-odoo]

We're an Odoo partner in Egypt, and we'd like to contribute to the documentation here.

Thank you for your help!

We've some suggestions to enhance the quality of documentation:

1. Specify Odoo version on new feature sections. Check Python Documentation under the end of section.

2. Split each module by category (End User, Implementation, Administration). Check Oracle Documentation and Gitlab Documentation as references.

I'm forwarding your suggestion to our content team: cc @jubodoo @Lau-Odoo

3. Please open translation for Arabic (Egypt) language on Transifex.

This has been done by our localization team: https://www.transifex.com/odoo/odoo-13-doc/language/ar/

Best regards

[anassahmed]

@rim-odoo Thanks for the response. We may start on documentation translation then, until you get back with your feedback on other suggestions.

[AntoineVDV]

Split each module by category (End User, Implementation, Administration). Check Oracle Documentation and Gitlab Documentation as references.

👍
I agree with the general idea but I would rather split by topic so that we don't duplicate the entire hierarchy of a module's doc for each category.

[anassahmed]

@AntoineVDV It doesn't matter, I think. Each module will have 3 sub-folder/documents: one for implementation, one for end user, and the 3rd for administration. Then, a script will compile each category from the folders based on apps.

We can also mark sections the same documentation as "implementation", "end-user", or "administration" and use CSS to hide those sections in their respective manuals, or show them all combined.