Skip to content

Commit

Permalink
UG update
Browse files Browse the repository at this point in the history
  • Loading branch information
garywongkai committed Apr 15, 2024
1 parent cd86cab commit 2e55b6f
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ The sequence diagram below illustrates the interactions within the `Logic` compo
**Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.
</box>

<div style="page-break-after: always;"></div>

How the `Logic` component works:

1. When `Logic` is called upon to execute a command, it is passed to an `AddressBookParser` object which in turn creates a parser that matches the command (e.g., `DeleteCommandParser`) and uses it to parse the command.
Expand Down Expand Up @@ -303,8 +305,6 @@ _{Explain here how the data archiving feature will be implemented}_

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

<div style="page-break-after: always;"></div>

## **Documentation, logging, testing, configuration, dev-ops**

* [Documentation guide](Documentation.md)
Expand Down Expand Up @@ -436,6 +436,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

<div style="page-break-after: always;"></div>

**Use case: UC04 - List all contacts**

Expand Down Expand Up @@ -545,7 +546,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

<div style="page-break-after: always;"></div>

**Use case UC09 - Delete a schedule**

Expand Down Expand Up @@ -579,6 +579,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

<div style="page-break-after: always;"></div>

**Extensions**

* 1a. The edited datetime format is invalid
Expand Down Expand Up @@ -623,8 +625,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

<div style="page-break-after: always;"></div>

### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
Expand All @@ -641,8 +641,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* **Module**: A slot in the day used for lesson
--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## **Appendix: Instructions for manual testing**

Given below are instructions to test the app manually.
Expand Down Expand Up @@ -671,6 +669,8 @@ testers are expected to do more *exploratory* testing.

1. _{ more test cases …​ }_

<div style="page-break-after: always;"></div>

### Deleting a person

1. Deleting a person while all persons are being shown
Expand Down Expand Up @@ -889,8 +889,6 @@ testers are expected to do more *exploratory* testing.

1. Other incorrect deleteSched commands: all previous incorrect deleteSched applies here

<div style="page-break-after: always;"></div>

1. Deleting a schedule while no persons are being shown

1. Prerequisites: List no persons using the `find` command. No person in the contact list. Assume there are 6 contacts in the entire contact list,
Expand All @@ -913,6 +911,8 @@ testers are expected to do more *exploratory* testing.

1. Other incorrect deleteSched commands: all previous incorrect deleteSched applies here

<div style="page-break-after: always;"></div>

### Saving data

1. Dealing with missing/corrupted data files
Expand All @@ -921,8 +921,6 @@ testers are expected to do more *exploratory* testing.

1. _{ more test cases …​ }_

<div style="page-break-after: always;"></div>

## **Appendix: Planned Enhancments**
1. Adding the color to the schedule display corresponding to the tag Person
2. Have a command to view a certain date, and show the schedule for that week/date
Expand Down

0 comments on commit 2e55b6f

Please sign in to comment.