|
8 | 8 |
|
9 | 9 | {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
|
10 | 10 |
|
| 11 | +### Storage Components |
| 12 | + |
| 13 | +API: `Storage.java` |
| 14 | + |
| 15 | +The `Storage` component, |
| 16 | +* can save flashcards in `flashcard.txt` in specific text format |
| 17 | +* can save events in `event.txt` in specific text format |
| 18 | +* saves automatically when changes occur. |
| 19 | +* component loads automatically when the program starts. |
| 20 | +* component can check if the saved txt file has been damaged. |
| 21 | + |
11 | 22 |
|
12 | 23 | ## Product scope
|
| 24 | + |
13 | 25 | ### Target user profile
|
14 | 26 |
|
15 |
| -{Describe the target user profile} |
| 27 | +TaskLinker is tailored towards university students who use flashcards to |
| 28 | +study for their courses and need an easy way to schedule and plan the |
| 29 | +studying of their flashcards. |
| 30 | + |
| 31 | +TaskLinker is a CLI tool and as such, it is tailored towards students who |
| 32 | +type fast and prefer a functional, but barebones app that runs in the |
| 33 | +terminal over a GUI that looks more impressive but is slower to use. |
| 34 | + |
| 35 | +As such, computer science students represent good target users of TaskLinker. |
16 | 36 |
|
17 | 37 | ### Value proposition
|
18 | 38 |
|
19 |
| -{Describe the value proposition: what problem does it solve?} |
| 39 | +TaskLinker is a CLI-tool for helping university students memorize flashcards |
| 40 | +and track their flashcard and general academic progress in the courses they are |
| 41 | +taking. |
| 42 | + |
| 43 | + |
20 | 44 |
|
21 | 45 | ## User Stories
|
22 | 46 |
|
23 |
| -|Version| As a ... | I want to ... | So that I can ...| |
24 |
| -|--------|----------|---------------|------------------| |
25 |
| -|v1.0|new user|see usage instructions|refer to them when I forget how to use the application| |
26 |
| -|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list| |
| 47 | +| Version | As a ... | I want to ... | So that I can ...| |
| 48 | +|---------|----------|---------------|------------------| |
| 49 | +| v1.0 |user|create new flashcards|add new knowledge I want to study| |
| 50 | +| v1.0 |user|list all my flashcards|get a quick overview of my flashcard collection| |
| 51 | +| v1.0 |user|review my flashcards|so that I can memorize their contents| |
| 52 | +| v2.0 |new user|be able to invoke a help command|get advice/tips for how to use TaskLinker if I don' know how| |
| 53 | +| v2.0 |user reviewing flashcards|rate how hard it was to remeber their content|see harder flashcards more often and easy flashcards less frequently during reviews| |
| 54 | +|v2.0 |experienced user|use the delete and review feature by typing a one-line command|be faster than having to go through the prompt-anser workflow these features usually require| |
27 | 55 |
|
28 | 56 | ## Non-Functional Requirements
|
29 | 57 |
|
|
0 commit comments