browsertrix
browsertrix copied to clipboard
[Feature]: Universal Help & Resources Button
Context
We have recieved lots of positive feedback about our included help strings in the workflow setup stages! In app help text is great, but sometimes users need more information or context than we want to provide on the page all at once. Now that we have good in-app written documentation, how can we best encourage its use and reduce the friction between a user needing help with what they're looking at and finding the relevant docs section?
Figma handles this pretty niceley and makes help available through a menu always present in the bottom right. I propose we steal this approach with a few changes to what exactly we serve in the menu based on how we're set up.
What change would you like to see?
As a user, I want to be able to find documentation quickly for what I'm looking at.
As a user, when I encounter bugs in the app I cannot fix myself, I want a place I can go to report them
Initial Mockup
Items in menu
Subject to change / omission where noted
- Page documentation
- Links to the most relevant documentation for the current page that the user is looking at. When creating or editing a workflow for example, this would link to workflow setup.
- Community Support Forum
- Video Tutorials
- ...Subject to those being created of course :)
- Submit Feedback ❓
- Do we want a dedicated feedback email? No promises of answers, perhaps direct to the forum?
- Contact Support
- Only available for plans with dedicated support included
- Page Source Code ❓
- Link to front end page source code on GitHub to encourage contribution?
Todo
This is great! "Page" might get a bit confusing on some pages once QA pages are released. Also, would be a bit complex to map pages to docs in first pass. How about for mvp we keep it pretty similar to the current footer and new issue list in github?
- "User Guide" https://docs.browsertrix.com/user-guide/
- "Community Help Forum" https://forum.webrecorder.net/c/help/browsertrix/24
- "Report an Issue" https://github.com/webrecorder/browsertrix/issues/new/choose
- "Follow us on GitHub" https://github.com/webrecorder/browsertrix
"Page" might get a bit confusing on some pages once QA pages are released.
I think even this sentence makes your point! 😂