Quiz phase 1 🚧

[apomalyn]

As a user, I want a place to practice my vocabulary, kanji, and kana

Requirements

The quiz feature contains everything that is under the Practice tab. It can be decomposed into the following:

• Practice tab home
• Knowledge level and quiz algorithm
• Quiz
• Custom quiz
• Kind of questions
• Miscellaneous (ads and notifications)

Practice tab

As a user, on the Practice tab, I want to:

• have a way to start an automatic quiz #162
• see the suggested quizzes 🚧
• have a way to create my quizzes 🚧
• see my most used custom quizzes 🚧

Knowledge level and quiz algorithm

As a user, I want to have: #218

• an automatic system to calculate my help learn efficiently using spaced learning (SM-2 or FSRS)
• see a humanly understandable representation of my knowledge (learned, practising, seen, never seen) based on the spaced learning
• the kind of questions on my quizzes to change regularly so I don't get bored but also changes how I practice

Quiz

As a user, when I start a quiz (suggested or user-made), I want to: #165

• the tags (aka groups) associated with the quiz
• the name of the quiz:
  • custom quiz --> name of the quiz
  • suggested quiz --> name of the quiz
• see the topic of the quiz if it's available. The topic should contain:
  • suggested or custom quiz --> the description of the quiz
  • lesson --> recapitulation or description of the lesson
• have a way to start the quiz
• have a way to cancel the quiz
• an option to not show this page again in the future

As a user, during a quiz, whatever the kind of question, I want to:

• see the current progress in the quiz (progress bar) #161
• have a way to end the quiz
• have a way to skip the question #161
• after I answered a question, I want to: #170
  • have a way to 'continue' (go to the next question or end the quiz)
  • see if my response is valid or not
  • see the correct answer (if available)
  • have a way to report the question if I think something went wrong

As a user, when I end a quiz, I want to: #210

• see my grade for the quiz
• the recapitulation of the quiz, for each question:
  • the status of my response:
  • right: good answer from the first time
  • partially right: failed to answer at least one time but answered correctly at one moment
  • failed: failed to answer correctly at least 3 times
  • skipped: skipped the question
  • the 'recap' of the question (e.g.: 友達 --> friend, 友達 --> ともだち, 友達 --> tomodachi)
• an option to 'continue' to the next screen (ads or go back to practice home)

Custom quiz 🚧

As a user, I want to be able to:

• create my own quizzes with the content I choose. It should have:
  • a name
  • a description
  • a number of question by quiz
  • a list of possible kinds of questions
  • a list of content:
  • list of kana to include in the quiz
  • list of kanji to include in the quiz
  • list of vocabulary to include in the quiz
• edit the content of my custom quizzes
• delete a custom quiz
• see all my custom quizzes
• practice a quiz set

Kind of questions

As a user, I want to have different kinds of questions shown during quizzes:

• one-word question: #181
  • shows a single kana, kanji, or vocabulary:
  • spell in romaji
  • spell in kana*
  • translate to the app language
  • shows a translation into the app language:
  • translate in romaji
  • translate in kana*
  • translate in kanji/kana*
• multiple choice: choose the answer between 2 to 4 choices. #168
  • Question is a single word. Choices can be:
  • kana (single kana if 4 choices available)
  • kanji (single kanji if 4 choices available)
  • vocabulary (only for 2 and 3 choices)
  • images (with a single word describing the image in the app language)
  • Question is an image. Choices can be:
  • kana (single kana if 4 choices available)
  • kanji (single kanji if 4 choices available)
  • vocabulary (only for 2 and 3 choices)
• word association between: #172
  • kanji/vocabulary --> kana and vice-versa
  • kanji/vocabulary --> translation and vice-versa
  • kana/kanji/vocabulary --> romaji and vice-versa
• sentence question: #188
  • shows one or multiple sentences:
  • in Japanese --> translate to the app language
  • in the app language --> translate to Japanese*
• drawing exercise (draw a kanji or kana) #201
• blank sentence question: #192
  • shows a single sentence in japanese, user needs to complete the blank using kana/kanji
• listen question: #185
  • read using TTS a kana, kanji or vocabulary, user needs to:
  • translate in app language
  • spell in kana
  • spell in romaji
  • spell (where the user selects the right answer based on a list)

* If the Japanese keyboard isn't available propose multiple solutions so the user can "build" its response

Miscellaneous

As a developer, I want to make some 💰: #213

• with ads displayed,
  • after each quiz (full page with interaction needed to go to the next screen)
  • during the loading of a quiz (validate if what is the minimum amount of time we need to show an ad)

As a user, I want to: #202

• receive a notification when it's time for me to practice
• be able to disable those notifications if I don't want them

Dependencies

Depends on:

• Some issues depend on #130
• Some issues depend on https://github.com/RoadTripMoustache/kana_to_kanji_api/issues/31

Parent of:

• 163

• Practice tab home

  • 162

• Knowledge level and quiz algorithm

  • 218

  • 297

• Quiz

  • 161

  • 165

  • 210

  • 298

• Kind of questions

  • 167

  • 179

  • 180

  • 169

  • 170

  • 171

  • 168

  • 172

  • 181

  • 185

  • 188

  • 192

  • 201

• Miscellaneous

  • 202

  • 213

Dev notes

• SM-2 algorithm explanation
• FSRS github