Skip to content

Commit

Permalink
Merge pull request nus-cs2113-AY2324S1#6 from AY2324S1-CS2113-F11-3/m…
Browse files Browse the repository at this point in the history
…aster

Update
  • Loading branch information
Cheezeblokz authored Oct 27, 2023
2 parents 5111380 + 261fd82 commit 036d5b4
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 8 deletions.
40 changes: 34 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,50 @@

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

### Storage Components

API: `Storage.java`

The `Storage` component,
* can save flashcards in `flashcard.txt` in specific text format
* can save events in `event.txt` in specific text format
* saves automatically when changes occur.
* component loads automatically when the program starts.
* component can check if the saved txt file has been damaged.


## Product scope

### Target user profile

{Describe the target user profile}
TaskLinker is tailored towards university students who use flashcards to
study for their courses and need an easy way to schedule and plan the
studying of their flashcards.

TaskLinker is a CLI tool and as such, it is tailored towards students who
type fast and prefer a functional, but barebones app that runs in the
terminal over a GUI that looks more impressive but is slower to use.

As such, computer science students represent good target users of TaskLinker.

### Value proposition

{Describe the value proposition: what problem does it solve?}
TaskLinker is a CLI-tool for helping university students memorize flashcards
and track their flashcard and general academic progress in the courses they are
taking.



## User Stories

|Version| As a ... | I want to ... | So that I can ...|
|--------|----------|---------------|------------------|
|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
| Version | As a ... | I want to ... | So that I can ...|
|---------|----------|---------------|------------------|
| v1.0 |user|create new flashcards|add new knowledge I want to study|
| v1.0 |user|list all my flashcards|get a quick overview of my flashcard collection|
| v1.0 |user|review my flashcards|so that I can memorize their contents|
| v2.0 |new user|be able to invoke a help command|get advice/tips for how to use TaskLinker if I don' know how|
| 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|
|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|

## Non-Functional Requirements

Expand Down
5 changes: 3 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

## Introduction

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

## Quick Start

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//@@author wendelinwemhoener

package seedu.duke.flashcard.command;

import seedu.duke.flashcard.FlashcardList;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//@@author wendelinwemhoener

package seedu.duke.flashcard.command;

import seedu.duke.flashcard.FlashcardList;
Expand Down

0 comments on commit 036d5b4

Please sign in to comment.