Skip to content

Commit 036d5b4

Browse files
authored
Merge pull request nus-cs2113-AY2324S1#6 from AY2324S1-CS2113-F11-3/master
Update
2 parents 5111380 + 261fd82 commit 036d5b4

File tree

4 files changed

+41
-8
lines changed

4 files changed

+41
-8
lines changed

docs/DeveloperGuide.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,50 @@
88

99
{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
1010

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+
1122

1223
## Product scope
24+
1325
### Target user profile
1426

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.
1636

1737
### Value proposition
1838

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+
2044

2145
## User Stories
2246

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|
2755

2856
## Non-Functional Requirements
2957

docs/UserGuide.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
## Introduction
44

5-
TaskLinker is a CLI-tool for helping students memorize flashcards and track
6-
their flashcard and generell academic progress in the courses they are taking.
5+
TaskLinker is a CLI-tool for helping university students memorize flashcards
6+
and track their flashcard and general academic progress in the courses they are
7+
taking.
78

89
## Quick Start
910

src/main/java/seedu/duke/flashcard/command/DeleteFlashcardCommand.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//@@author wendelinwemhoener
2+
13
package seedu.duke.flashcard.command;
24

35
import seedu.duke.flashcard.FlashcardList;

src/main/java/seedu/duke/flashcard/command/DualFlashcardCommand.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//@@author wendelinwemhoener
2+
13
package seedu.duke.flashcard.command;
24

35
import seedu.duke.flashcard.FlashcardList;

0 commit comments

Comments
 (0)