Skip to content

Tool documentation button

Tool UX: User

A great UX improvement, is to have a link to the docs from your tools.
This way users always know where the docs live.

Sample tool without clear docs

Have a look at this image.
200
How does this tool work? What does it Do? Where to find the docs?

Tool UX: Dev

As a dev, I want to easily add a documentation button or menu to my tool.

Hardcode approach

The easiest method would be, just add a qt button to the top.

PRO

  • no dependencies
    CONs
  • less consistent, harder to update tools in bulk
sample hardcoded docs button

At Mediatonic we had a docs button always in the same place
300

Dependency approach

a qt_custom_window could do this.

sample of a custom qt window

2022-12-31-1672479992574.jpeg

the dev who writes this tool can do

import docsbar
wrapped_widget = docsbar.wrap(mywidget)
wrapped_widget.url = "www.docs.com"

add docsbar to the dependencies / requirements file
the docsbar dependency auto installs through pip on install.

tooldev