Tirsvad
0b983b7fda
New milestone MIL-008 with story US-001.06, and the design documents updated for the level choice: BC-001, PP-001, US-001, UC-001, DM-001, DICT-001, SSD-001, OC-001, SD-001, DCD-001 and the wireframe. Review records RC-030 to RC-040, all Go (autonomous mode, not independent). Task: MIL-008#1
87 lines
4.0 KiB
Markdown
87 lines
4.0 KiB
Markdown
# UC-001: Study Flash Cards
|
|
|
|
## Metadata
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| ID | UC-001 |
|
|
| CrossReference | [UCD-001], [US-001], [SA-001], [DM-001], [SSD-001] |
|
|
| Language | en |
|
|
| Domain | it |
|
|
|
|
## Version History
|
|
| Date | Status | Author | Reviewer | Change | Commit |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| 2026-10-14 | Deprecated | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [c3fbcbc] |
|
|
| 2026-10-14 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Added the choice of level (US-001.06) | pending |
|
|
|
|
---
|
|
|
|
**Format:** Fully Dressed
|
|
|
|
## Fully Dressed
|
|
|
|
- **Scope:** Flash Card program
|
|
- **Level:** user-goal
|
|
- **Primary Actor:** Learner
|
|
- **Stakeholders and Interests:**
|
|
- S01 — learns the Malay words and wants only unknown words to come up
|
|
- S02 — wants to see the assignment's behaviour step by step
|
|
- **Preconditions:**
|
|
- A word list exists.
|
|
- A display is available.
|
|
- **Postconditions (success guarantee):**
|
|
- The words the Learner marked as known are no longer in the words to learn.
|
|
- The words to learn are kept, so that the next session starts from them.
|
|
|
|
### Main Success Scenario
|
|
|
|
1. The Learner starts the program.
|
|
2. The system offers the levels: 100 words, 1000 words and all words.
|
|
3. The Learner chooses a level.
|
|
4. The system loads the words to learn: from the kept progress when it exists, otherwise from the word list.
|
|
5. The system shows a random card, with the word in Malay, from the first words of the word list that fit the level and are still to learn.
|
|
6. After three seconds the system turns the card over and shows the translation in Danish.
|
|
7. The Learner states that the word is known.
|
|
8. The system removes the word from the words to learn and keeps the words to learn.
|
|
9. The system shows a new random card of the level, and the Learner repeats from step 6 until no word is left at the level.
|
|
|
|
### Extensions (Alternative / Exception Flows)
|
|
|
|
- 3a. The Learner has given the level when starting the program:
|
|
1. The system skips steps 2 and 3 and goes on at step 4.
|
|
- 5a. Spoken words are available on the Learner's machine:
|
|
1. The system speaks the Malay word. If speaking fails, the system logs it and goes on.
|
|
- 7a. The Learner states that the word is not known:
|
|
1. The system keeps the word in the words to learn and shows a new random card of the level; the Learner goes on at step 6.
|
|
- 7b. The Learner answers before three seconds have passed:
|
|
1. The system cancels the turn-over of the card being shown and starts a new one for the next card.
|
|
- 9a. No word is left at the level:
|
|
1. The system tells the Learner that there is nothing left to learn at this level, and further answers change nothing.
|
|
- 4a. The kept progress or the word list is unreadable:
|
|
1. The system reports the problem to the Learner and ends; it does not overwrite the kept progress.
|
|
|
|
### Special Requirements / Business Rules
|
|
|
|
| Step | Rule |
|
|
| --- | --- |
|
|
| 2, 3 | A level is a number of words (100 or 1000) or all words |
|
|
| 5 | The word list is ordered from the most to the least frequent word; a level of N words is its first N words; a list shorter than N is used whole |
|
|
| 5, 9 | The next card is chosen at random from the words of the level that are still to learn |
|
|
| 6 | The turn-over comes three seconds after the card appears |
|
|
| 8 | A word is identified by its Malay and Danish text; the first equal word is removed; known words stay known at every level and words outside the level are kept |
|
|
| 4 | The word list names its two languages and holds one word and one translation per card |
|
|
|
|
### Open Issues
|
|
|
|
- Starting again (resetting the kept progress) is not offered in the program; deleting the kept progress does it.
|
|
- Going back to the level choice without restarting the program is not offered.
|
|
|
|
---
|
|
|
|
[UCD-001]: ../use-case-diagram.md
|
|
[US-001]: ../user-stories.md
|
|
[SA-001]: ../stakeholder-analysis.md
|
|
[DM-001]: ../domain-model.md
|
|
[SSD-001]: ./ssd.md
|
|
[c3fbcbc]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/031-flash-card/commit/c3fbcbcfaf799e0ae34aed7e14d3bc8a62f03db3
|