Skip to content

Commit

Permalink
Update Schedule Sequence Diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
Rikko1204 committed Apr 10, 2024
2 parents fd45bdd + c88a7a1 commit efa31f9
Show file tree
Hide file tree
Showing 101 changed files with 1,975 additions and 276 deletions.
7 changes: 6 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,12 @@ dependencies {
}

shadowJar {
archiveFileName = 'addressbook.jar'
archiveFileName = 'aronapro.jar'
}

run {
enableAssertions = true
}


defaultTasks 'clean', 'test'
81 changes: 64 additions & 17 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pageNav: 3
---

# AB-3 Developer Guide
# AronaPro Developer Guide

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -50,7 +50,7 @@ The bulk of the app's work is done by the following four components:

**How the architecture components interact with each other**

The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete E0123456`.
The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete id/E0123456`.

<puml src="diagrams/ArchitectureSequenceDiagram.puml" width="574" />

Expand Down Expand Up @@ -90,7 +90,7 @@ Here's a (partial) class diagram of the `Logic` component:

<puml src="diagrams/LogicClassDiagram.puml" width="550"/>

The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete E0123456")` API call as an example.
The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete id/E0123456")` API call as an example.

<puml src="diagrams/DeleteSequenceDiagram.puml" alt="Interactions Inside the Logic Component for the `delete E0123456` Command" />

Expand Down Expand Up @@ -386,6 +386,7 @@ _{more aspects and alternatives to be added}_
_{Explain here how the data archiving feature will be implemented}_



--------------------------------------------------------------------------------------------------------------------

## **Documentation, logging, testing, configuration, dev-ops**
Expand All @@ -404,15 +405,14 @@ _{Explain here how the data archiving feature will be implemented}_

**Target user profile**:

* Tech-savvy university Computer Science teaching assistants
* manages an array of students and professors’ contacts
* appreciates an organized and vibrant approach to query, and manage contacts with CLI
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps
* Tech-savvy university Computer Science teaching assistants and professors
* Manages an array of students, professors and students' contacts
* Appreciates an organised approach to query, and manage contacts with CLI
* Prefers desktop apps over other types
* Prefers typing to mouse interactions
* Someone who is reasonably comfortable using CLI application

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
**Value proposition**: Manage contacts faster than a typical mouse/GUI driven app


### User stories
Expand Down Expand Up @@ -654,6 +654,52 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes at step 1.

**Use case: deletes a group of people**

**MSS**

1. User requests to delete all people in a specific group.
2. User inputs the name of the group into the AddressBook.
3. AddressBook deletes all people that are classified under the specified group.

**Extensions**

* 1a. User uses the wrong format in his request.

* 1a1. AddressBook shows an error message.
* 1a2. User uses the correct format as shown in the error message for his request.

Use case resumes at step 2.

* 2a. The group does not exist.

* 2a1. AddressBook shows an error message.

Use case ends.

**Use case: Pins a contact**

**MSS**

1. User requests to pin a specific contact.
2. AddressBook pins the specified contact.

Use case ends.

**Extensions**

* 1a. User uses the wrong format in his request.

* 1a1. AddressBook shows an error message.
* 1a2. User uses the correct format as shown in the error message for his request.

Use case resumes at step 2.

* 2a. The contact does not exist.

* 2a1. AddressBook shows an error message.

Use case ends.


### Non-Functional Requirements
Expand Down Expand Up @@ -691,7 +737,8 @@ testers are expected to do more *exploratory* testing.

1. Download the jar file and copy into an empty folder

1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
1. cd into that folder and execute the command `java -jar AronaPro.jar`
2. Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

1. Saving window preferences

Expand All @@ -702,19 +749,19 @@ testers are expected to do more *exploratory* testing.

1. _{ more test cases …​ }_

### Deleting a person
### Example: Deleting a person

1. Deleting a person while all persons are being shown
1. Deleting a person with a specified `while all persons are being shown

1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.

1. Test case: `delete E0123456`<br>
1. Test case: `delete id/E0123456`<br>
Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

1. Test case: `delete E0000000`<br>
1. Test case: `delete id/E0000000`<br>
Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is NusId which does not exist currently in the address book)<br>
1. Other incorrect delete commands to try: `delete`, `delete id/x`, `...` (where x is NusId which does not exist currently in the address book)<br>
Expected: Similar to previous.

1. _{ more test cases …​ }_
Expand Down
Loading

0 comments on commit efa31f9

Please sign in to comment.