question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Provide users with contextual help

See original GitHub issue

Is your feature request related to a problem? Please describe.

Many of the modeler fields and its usage is very complex due to the nature of usage of the bpmn engine. (not a negative, just a fact of mature systems):

screen shot 2019-01-18 at 10 32 34 am

Describe the solution you’d like

Would be great if we could have a configurable helptext button that can be injected into every input that allows the user to select to grab some quick context of what is expected for the field.

This would be something that the community can built out with different versions of complexity and tailor for their internal use cases and user base.

Describe alternatives you’ve considered

  • Provide better linking and contextual help without the need for configuration.

Additional context

Example, illustrating the issue for the variables field shown above: What are my options? I need to refer back to docs (and I cannot really because the link does not exist).

Would be great that when we say int he config to add/inject the help it just adds a small “?” like button next to the input that a user can select (or whatever UI equiv would accomplish the same goal). The goal is not to have the text constantly visual, and thus clutter the UI; it should only show when the user needs some additional quick reference info about the input field.

Issue Analytics

  • State:open
  • Created 5 years ago
  • Reactions:2
  • Comments:9 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
ingorichtsmeiercommented, Jan 28, 2019

Maybe customers exchange the links into the camunda docs with links into their wiki.

A central collection with all links links (maybe in a property file) would help to maintain them.

0reactions
nikkucommented, Feb 1, 2019

Thanks for the detailed examples.

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is Contextual Help, and how it can lead to happier ...
Contextual help is an essential way to provide assistance to your users, without requiring them to leave the comfort of your software user...
Read more >
What Is Contextual Help? The Key to Happy Customers
Contextual help provides concise information to users based on their current state and with minimal disruption in their ongoing workflow.
Read more >
Tips for building contextual help in web applications
Contextual Help is an action given to provide assistance. It is integrated inside a product without the need to read the full documentation....
Read more >
Provide contextual help
Contextual help, which provides support for what the user is currently interacting with, is accessible to people with cognitive, reading, and learning ...
Read more >
Introduction to Contextual Help
Contextual help is integrated assistance to your help site, making an easy-to-read experience for your Knowledge Base. It guides users on what a...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found