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

Improve presentation of hints for the student. #4492

Closed
seanlip opened this issue Aug 4, 2022 · 1 comment · Fixed by #4500
Closed

Improve presentation of hints for the student. #4492

seanlip opened this issue Aug 4, 2022 · 1 comment · Fixed by #4500
Assignees
Labels
Z-ibt Temporary label for Ben to keep track of issues he's triaged.

Comments

@seanlip
Copy link
Member

seanlip commented Aug 4, 2022

Is your feature request related to a problem? Please describe.
The current hints design is not intuitive, and students don't intuitively understand how to use it.

Describe the solution you'd like

Here are @mschanteltc's updated designs for the hints screen. Generally, there are 3 states of the Hint Card -- Unrevealed, Expanded, and Collapsed. (Note: open the links in an incognito window to play the interactive prototype.)

  • Hint 1
    • Note: For all hints, when the user hits "Reveal Hint," it will change from the Unrevealed state to the Expanded state.
  • Hint 2
    • IMPORTANT: Please note that there is a design limitation of this prototype which is there because implementing it in the prototype would take too long. Specifically: within the prototype, when Hint 2 is revealed and Hint 1 is expanded afterwards, Hint 2 returns back to "Reveal Hint." This should not happen. If the hint is revealed, it can never go back to the Unrevealed state.
  • Solution
    • IMPORTANT: Please note that there is a design limitation of this prototype -- when a Hint Card is opened, it currently overlaps any Hint Cards beneath it. This is not supposed to happen. Instead, all cards below the expanded hint card should transition downwards. This can be seen in the Hint 2 mock above, when Hint 1 is expanded.

Overall note (IMPORTANT): In the prototypes above, the hint/solution cards cover the "Return to Lesson" button when expanded. This should not happen, and it only works the way it currently does because of the limited time available to implement the prototype. Instead, in all cases, the "Return to Lesson" button should transition downwards (such as when the Hint 1 Card is expanded in this prototype).

Notes on the design:

  • It's fine for multiple hint cards to be expanded at the same time. This is because students might want to refer to other hints while reading a given hint, in order to get the necessary context.
  • For "Reveal solution", it's fine to keep the confirmation dialog. But if dropping it is easier, we can do that too. Let's do what's technically easiest here.
  • Hints should appear one by one after a certain amount of time has elapsed. When the user is in the Hint Modal, the timer should not be counting. This is because there should be at least some time which the learner can use to think about and apply the suggestions in the hint before we prompt them with a follow-up hint.

Additional context

Here is what the hints screen currently looks like. The dropdown arrow is not clear and there are too many clicks needed to get to the hint. Students also struggle to exit the hints page.
image7

@seanlip seanlip added this to the Alpha MR5 milestone Aug 4, 2022
@rt4914 rt4914 self-assigned this Aug 15, 2022
@BenHenning BenHenning self-assigned this Aug 17, 2022
BenHenning added a commit that referenced this issue Aug 19, 2022
## Explanation
Fixes #4492 by introducing a complete revamp of the hint & solution management flow in the app (see designs below).

Fixes #3537 by merging the hint summary layouts.

Note that one part of #4492 isn't implemented: pausing the hint timer while hints are being viewed. Ensuring this is properly implemented is being tracked as part of #4510.

Two new test exemptions were added: one for a new view model file (which seems sensible since most of the changes in this PR are aesthetic and not functional), and a second for a new hints configuration module that's specific to the alpha user study build of the app (which is temporary and we generally don't test thoroughly, anyway).

**Designs**
https://xd.adobe.com/view/3dca36c2-5115-419c-b25e-0f10526b077c-6899/screen/619724cc-0ecf-4c32-a452-432fded803f5/specs/
https://xd.adobe.com/view/3dca36c2-5115-419c-b25e-0f10526b077c-6899/screen/5311124a-b143-4916-aa46-6e318aca5650/specs/
https://xd.adobe.com/view/3dca36c2-5115-419c-b25e-0f10526b077c-6899/screen/545c6f32-2fec-4a8b-bb53-cecfb8e52f31/specs/

## Essential Checklist
- [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
- [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation.
- [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide).
- [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)).
- [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop".
- [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).

## For UI-specific PRs only
If your PR includes UI-related changes, then:
- Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes
- For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines))
- Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-(A11y)-Guide))
- Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing

## Mobile Portrait

<img src="https://user-images.githubusercontent.com/9396084/184692122-20fe436f-9665-4870-865a-08df78c41200.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184692133-f9415819-06eb-4ab2-b4b1-729c7d7bb0ae.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184692140-19016b5b-9911-4b69-a990-032ba417f33b.png" width="250" />

<img src="https://user-images.githubusercontent.com/9396084/184692143-62899a72-7b89-4e0f-b32f-0bc98f62785a.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184692144-cba61f52-e37f-40b9-ac0c-b58287974699.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184692145-71a50dc6-e91c-464e-967a-778d62a6c81d.png" width="250" />

## Mobile Landscape

<img src="https://user-images.githubusercontent.com/9396084/184692403-51e1929e-b99f-4af5-b2cf-c3d61cb0e242.png" width="350" /> <img src="https://user-images.githubusercontent.com/9396084/184692422-7d8c37d2-683b-4ac9-ad2b-f1d96344f1be.png" width="350" />


<img src="https://user-images.githubusercontent.com/9396084/184692426-94573514-6caf-4237-b9b4-f413675aa19c.png" width="350" /> <img src="https://user-images.githubusercontent.com/9396084/184692432-22435a68-c266-46d0-baf3-5f2662ab33d4.png" width="350" />

## Tablet

<img src="https://user-images.githubusercontent.com/9396084/184694579-b4fbaf8e-44b3-4321-8464-def773cd5e6d.png" width="250" />  <img src="https://user-images.githubusercontent.com/9396084/184694593-19870c10-81be-4b9e-a737-86954358f5aa.png" width="250" />

## Return to Lesson button

**NOTE**: This button was created later on that's why not all screenshots contain this button but the below screenshot should suffice. It is fully functional too.

<img src="https://user-images.githubusercontent.com/9396084/184706834-1cfa14c7-24a5-42f7-be46-252ab48ec536.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184706842-07fcdfcb-4413-48bf-9aaf-5d1da4dde12e.png" width="250" /> <img src="https://user-images.githubusercontent.com/9396084/184706856-cc76720b-7ccb-41c8-83b7-742e9820a70c.png" width="250" /> 


<img src="https://user-images.githubusercontent.com/9396084/184706853-510c4b6c-c964-439c-8013-426feceb5116.png" width="450" /> 

## Dark Mode (Not Implemented)

Do not have designs for dark mode

## RTL Support

<img src="https://user-images.githubusercontent.com/9396084/184695143-6852926b-d380-424f-9105-a10a05de8836.png" width="250" />

## Accessibility Output

There are few issues but not solving them right now.

## Video Output

https://user-images.githubusercontent.com/9396084/184695958-d23f1d77-a2f0-43bd-848a-43483f11fb04.mp4

Commits:

* UI for xml files

* Removed divider

* Removed const value

* Multie expand issue fixed

* Tablet UI changes

* Added return to topic button

* Removed index multiplier from tests

* Updated tests

* nit fixes

* nit fixes

* Fixed implementation

* Updated tests

* Fixed test case

* Bazel fix

* Minor suggested changes

* Nit fixes

* Revert back string change for hint button.

* Fix broken hints.

Update hint delay times for the Kenya-specific alpha build of the app.

Co-authored-by: Ben Henning <[email protected]>
Repository owner moved this from Needs Triage to Done in [Team] Core Learner and Mastery flows & UI Frontend - Android Aug 19, 2022
@KolliAnitha
Copy link

Hints UI is changed and all the hints are properly aligned and expanded. Verified in 0.8-alpha-091b45a188.
Screenshot_2022-08-20-18-26-09-40_943a62cb4c6fb83e010e1c2e82766a17

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Z-ibt Temporary label for Ben to keep track of issues he's triaged.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants