RolnickLab / ami-platform

GNU General Public License v3.0
8 stars 2 forks source link

Clarify entity types and terminology in UI #399

Open annavik opened 1 month ago

annavik commented 1 month ago

After processing some of the user feedback, it seems to be some confusions around the entity types and also the terminology in some cases. For example, what defines a "deployment"? What is a "site"? What does a "collection" include?

To prevent this, I suggest we include some clarifications in the UI here. To not disturb seasoned users with information, I suggest we show this information on demand, for example using tooltips. We could show a short description and also include a link to more detailed information, when we have a wiki?

joseepoirier commented 1 month ago

Agree that the terminology causes confusion for users. We started defining some of the terms in the specs + manuals we're writing, but that to me feels like a bandaid that doesn't address the cause.

Should we consider a 3-step in-app tutorial for the public launch?

annavik commented 1 month ago

Here are some quick code sketches I made for a streamlined "entity header" where we can include such clarifications:

Skärmavbild 2024-06-07 kl  15 02 13

Skärmavbild 2024-06-07 kl  15 02 43

Skärmavbild 2024-06-07 kl  15 03 11

annavik commented 1 month ago

Also this header can be place for other "entity actions", such as create? Andre can probably refine this a bit though!

annavik commented 1 month ago

Agree that the terminology causes confusion for users. We started defining some of the terms in the specs + manuals we're writing, but that to me feels like a bandaid that doesn't address the cause.

Should we consider a 3-step in-app tutorial for the public launch?

Yes I agree just explanations is probably not enough in some cases. We might want to rethink some concepts and also introduce abstractions (for example for collections used in jobs?), but I suggest we keep this specific task about the clarifications only, to avoid it getting too large :)

annavik commented 1 month ago

Waiting on design spec here, blocked for now.