Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Research ways to improve UX for context selection and qna creation #554

Open
Misjohns opened this issue Feb 6, 2025 · 4 comments
Open
Assignees
Labels
UX Related to the user experience
Milestone

Comments

@Misjohns
Copy link
Collaborator

Misjohns commented Feb 6, 2025

Description

UX is exploring ways to improve the experience of selecting contexts and creating QnA pairs.

Goal

  • To validate the requirements for MVP and future releases for upstream and downstream.
  • Use designs to conduct user testing to collect feedback from potential users
  • Open discussion around technology opportunities and limitation (MVP and future releases for upstream and downstream)
  • Prioritize features for MVP and future releases for upstream and downstream
  • Collect feedback from the community and downstream teams
@Misjohns Misjohns added the UX Related to the user experience label Feb 6, 2025
@Misjohns Misjohns self-assigned this Feb 6, 2025
@Misjohns Misjohns added this to UI Feb 6, 2025
@Misjohns
Copy link
Collaborator Author

Misjohns commented Feb 6, 2025

Concept designs from 24-Jan-2025

Step 3: Create seed data

User has successfully uploaded their resource documents and selects the MD file they'd like to start selecting context from.

Select context
Image

Context selection modal

  • Each document appears in a tab so user can easily switch MD files.
  • Search allows user to quickly locate some text within the current tab
  • User can toggle between a formatted vs simple MD view.
  • Inline alert displays a count for the context requirements
  • Yellow highlighted text shows previously selected context and blue is the current selection.
  • Context cards in the right panel provide a visual to help track their selection progress.
  • Context card includes overflow action so user can easily delete a context
  • When user has highlighted enough text (characters) the Add context button changes to active
  • Clicking the Add context button adds blue highlighted context to a card
  • Clicking cancel should display a warning message that all context selections will be lost
  • Helper text displays highlighted text character count

Formatted MD view
Image

Simple MD view
Image

Submit context
Once the user has selected the required 5 contexts across their documents, the Submit button displays.

Question: We are showing icons on the tabs to indicate that the required # contexts from each document have been achieved. UX would like clarification on this context count requirement. Is it five across all MD files or five for each MD file?

Image

Create Q&A pairs

When the user submits their context they can begin creating their question and answer pairs.

Context cards
Each context is displayed in a card with an indication that Q&A pairs have not been created. Each context requires 3 qnA pairs to be created.

Image

Q&A form
Clicking Create Q&A pairs on the context card expands the Q&A form.

Image

Once every context card has met the required 3 Q&A pairs the Next button is activated.

Image

Step 4: Review

The user lands on their review step and can see their context and Q&A pairs.

Image

@Misjohns
Copy link
Collaborator Author

Misjohns commented Feb 6, 2025

Concept design 6-Feb-2025

Create seed data

Concept of combining the context and Q&A pair creation. User can jump back and forth between context selection and Q&A pair creation.
Image

Once a context has been created, a Create Q&A pair button appears on the context card. Clicking this opens the Create Q&A pair modal.
Image

Create Q&A pairs modal
All selected context cards appear in this view. The one the user clicked on to open the modal is expanded and receives focus.
Image

@vishnoianil
Copy link
Member

@Misjohns Need a clarification. Are we vetting between the two of these design options, or the latest one is the one we will go with?

@vishnoianil vishnoianil moved this to Ready in UI Feb 7, 2025
@vishnoianil vishnoianil added this to the release-1.2 milestone Feb 7, 2025
@Misjohns
Copy link
Collaborator Author

@vishnoianil We want to figure out which of these 2 experiences users prefer. The first options has the user select all their contexts first, then they enter their QnA pairs to complete the Create Seed Data (step 3). The second design shows the experience of the user being able to enter the QnA pairs along with the context or after selecting all 5 contexts.

@Misjohns Misjohns moved this from Ready to In progress in UI Feb 11, 2025
@Misjohns Misjohns moved this from In progress to Backlog in UI Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UX Related to the user experience
Projects
Status: Backlog
Development

No branches or pull requests

2 participants