Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify use cases section in DeveloperGuide #59

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
101 changes: 90 additions & 11 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,33 +262,112 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Use cases

(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
(For all use cases below, the **System** is the `Academic Schedule Manager` and the **Actor** is the `user`, unless specified otherwise)

**Use case: Delete a person**
**Use case: UC01 - Add an assignment**

**MSS**

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
1. User requests to add an assignment.
2. Academic Schedule Manager adds the assignment.
3. Academic Schedule Manager shows a success message with details of the assignment added.

Use case ends.

**Extensions**

* 2a. The list is empty.
* 1a. The user didn't supply all required parameters.

* 1a1. Academic Schedule Manager shows an error message.

Use case ends.


* 1b. The given DEADLINE_OF_ASSIGNMENT parameter is in the wrong format.

* 1b1. Academic Schedule Manager shows an error message.

Use case ends.

Use case ends.

* 3a. The given index is invalid.
**Use case: UC02 - Delete an assignment**

**MSS**

1. User <ins>requests to list assignments and lessons (UC05)</ins>.
3. User requests to delete a specific assignment in the list.
4. Academic Schedule Manager deletes the assignment.

Use case ends.

**Extensions**

* 3a1. AddressBook shows an error message.
* 3a. The given index is invalid (index is referring to a lesson or index is out of range).

* 3a1. Academic Schedule Manager shows an error message.

Use case resumes at step 2.

*{More to be added}*

**Use case: UC03 - Import timetable**

**MSS**

1. Pseudo steps
2. User requests to delete a specific assignment in the list.
3. Academic Schedule Manager deletes the assignment.

Use case ends.

**Extensions**

* 3a. The given index is invalid (index is referring to a lesson or index is out of range).

* 3a1. Academic Schedule Manager shows an error message.

Use case resumes at step 2.


**Use case: UC04 - Remind**

**MSS**

1. Pseudo steps
2. User requests to delete a specific assignment in the list.
3. Academic Schedule Manager deletes the assignment.

Use case ends.

**Extensions**

* 3a. The given index is invalid (index is referring to a lesson or index is out of range).

* 3a1. Academic Schedule Manager shows an error message.

Use case resumes at step 2.


**Use case: UC05 - List assignments and lessons**

**MSS**

1. User requests to list assignments and lessons.
2. Academic Schedule Manager shows a list of all assignments and lessons.

Use case ends.

**Extensions**

* 1a. User requests to list XX day(s) of assignments and lessons.

* 1a1. Academic Schedule Manager shows a filtered list of assignments and lessons.

Use case ends.

* 2a. The list is empty.

Use case ends.

### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
Expand Down