Built-in Help
by Viindoo
| Lines of Code | 994 |
| Technical name | viin_built_in_help |
| License | OPL-1 |
| Website | https://viindoo.com/apps/modules/17.0/viin_built_in_help?force_show=1 |
| Read description for | v 15.0 v 16.0 |
Help where the question is asked - on the field itself
Documentation links and videos attached to fields, models, menus and apps, so the answer is one hover away instead of one search engine away.
Built-in Help (technical name viin_built_in_help) is an Odoo 17.0 app for Odoo Community and Odoo Enterprise and Viindoo Cloud, built for new user, implementer, trainer, support.
At a Glance
The facts of Built-in Help, version 0.1.0, in one place. Published by Viindoo.
How It Works
Two screens.
Fields can carry help
Documentation and video links live on the field definition, next to its label and help.
And so can apps and menus
The same mechanism for a module or a menu - help attached where the user is.
What You Get
Documentation and video links on fields
The same on models, menus and modules
Delivered through the framework, so it works anywhere the field appears
Per language, so a multilingual database points at the right page
Defined in module data - versioned with the code
No new app for users to open
More Screens
Everything below was taken on a database seeded with real business data, on this series - not a mock-up and not a screenshot from an older version.
Apps
What This App Does Not Do
Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.
It carries links to what you wrote.
The page or the video lives wherever you publish it.
Its value shows in the modules that use it.
This is contextual help, not a guided walkthrough.
Works Well With
Apps from the same stack, built to fit this one:
Who Should Use Built-in Help?
New user
Gets an explanation where the confusion is.
Implementer
Attaches documentation to the field instead of writing another guide.
Trainer
Points a recording at the exact screen it is about.
Support
Answers a question by attaching a link, permanently.
Frequently Asked Questions
What does Built-in Help do?
Documentation links and videos attached to fields, models, menus and apps, so the answer is one hover away instead of one search engine away.
What does Built-in Help not do?
It does not write documentation. It carries links to what you wrote. Links are data, not content. The page or the video lives wherever you publish it. It is a framework layer. Its value shows in the modules that use it. No in-app tour. This is contextual help, not a guided walkthrough.
Who is Built-in Help for?
New user: Gets an explanation where the confusion is. Implementer: Attaches documentation to the field instead of writing another guide. Trainer: Points a recording at the exact screen it is about. Support: Answers a question by attaching a link, permanently.
Which Odoo version and editions does it support?
Odoo 17.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.
What does it depend on?
It installs on top of: web. Odoo installs them with it.
How do I set it up?
Two screens.
What works well with it?
Documentation Website (to_website_docs): Where the pages those links point at live. eLearning (viin_website_slides): The videos a field can point at. Viindoo Base (to_base): The foundation layer underneath.
Can I try it before buying?
Yes - the Live Preview button at the top of this page opens the module's own screen on a working database.
How do I get support?
Write to apps.support@viindoo.com with your Odoo version and the technical name viin_built_in_help; pre-sales questions go to sales@viindoo.com.
See Built-in Help in Action
Live demo: v17demo-int.viindoo.com/web#action=base.action_model_fields
Need help with Built-in Help?
For questions, implementation support or a custom feature, contact Viindoo.
Pre-Sales & Partnership
sales@viindoo.comUpgrades to a newer Odoo series are a separate purchase for that series.
All Viindoo apps: apps.odoo.com/apps/modules/browse?author=Viindoo
Technical Requirement
Changes log
0.1.0 - Latest on the 17.0 line
- Help links can be declared per language, alongside the field's own help text.
This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software.
The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.