search

paranext / paranext-core

Electron client, extension host, and C# library for Paranext
https://paranext.github.io/paranext-core/
MIT License
17 stars 2 forks source link

Provide User Help #1155

Open ianhewubs opened 1 month ago

ianhewubs commented 1 month ago

As a user of Paratext 10, I need to have some idea how to use this new-to-everyone software in order to make progress learning how to use it.

Initially, help material will be scarce and supporters unfamiliar with the software. Being able to access help material and be signposted to places where I can find more help will be important. Thinking about how we integrate help into the application early on ought to be beneficial from the standpoints of UI design, development integration and analytics.

tjcouch-sil commented 1 month ago

I propose we consider creating a system in which people can define tutorial scripts that the software can walk the user through. The tutorials could show something in a modal, dim the screen and highlight just one thing to click on with a description box near it, etc. Thinking this might be effective since the software is so modular that everyone's UI will probably look different. Instead of showing a video where the UI looks some way because it has extensions X, Y, and Z, we just load up the tutorial right in the user's software, and the menu items will be wherever they actually are for that user. Just one idea :) I imagine this would probably take significant effort.

ianhewubs commented 1 month ago

@tjcouch-sil Yes, "tour-guide" helps are an option I'd like to explore, especially since there are off the shelf options for these. I suspect we will ultimately need to provide Help in more than one format. Perhaps a combination of low and higher effort solutions.