Skip to content

Commit

Permalink
Update DeveloperGuide.md
Browse files Browse the repository at this point in the history 
new user story, planned enhancements
  • Loading branch information
@WinstonLeonard
WinstonLeonard committed Nov 14, 2023
1 parent c2559ff commit b59b766
Showing 1 changed file with 22 additions and 16 deletions.
38 changes: 22 additions & 16 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -558,19 +558,20 @@ The following sequence diagram shows how unpaidAll command works:
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`


| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|---------|---------------------------------------------------------|------------------------------------------------------------------------|
| `* * *` | tutor | view a list of all tutees | see whoever are my tutees that I teach |
| `* * *` | tutor | view the specific details of a single tutee | see the different informations tailored to the tutee |
| `* * *` | tutor | add a new tutee | keep track of my tutees that I teach |
| `* * *` | tutor | find a tutee | search for a specific tutee that I teach |
| `* * *` | tutor | edit their details | account for changes in their information e.g. change in address |
| `* *` | tutor | remove tutees from the list | keep track of tutees that I have stopped teaching |
| `* *` | tutor | mark students that have already paid | keep track of students' payment statuses |
| `* *` | tutor | check all students who haven't paid | easily remind students who haven't paid |
| `* *` | tutor | undo and redo commands I made in the application | easily revert any mistakes |
| `* *` | tutor | calculate my total monthly revenue | better financially plan for my tutoring business |
| `* *` | tutor | view a list tutees whose lessons fall on a specific day | be reminded if I have any classes on that particular day |
| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|---------|---------------------------------------------------------|-----------------------------------------------------------------|
| `* * *` | tutor | view a list of all tutees | see whoever are my tutees that I teach |
| `* * *` | tutor | view the specific details of a single tutee | see the different informations tailored to the tutee |
| `* * *` | tutor | add a new tutee | keep track of my tutees that I teach |
| `* * *` | tutor | find a tutee | search for a specific tutee that I teach |
| `* * *` | tutor | edit their details | account for changes in their information e.g. change in address |
| `* *` | tutor | remove tutees from the list | keep track of tutees that I have stopped teaching |
| `* *` | tutor | mark students that have already paid | keep track of students' payment statuses |
| `* *` | tutor | check all students who haven't paid | easily remind students who haven't paid |
| `* *` | tutor | undo and redo commands I made in the application | easily revert any mistakes |
| `* *` | tutor | calculate my total monthly revenue | better financially plan for my tutoring business |
| `* *` | tutor | view a list tutees whose lessons fall on a specific day | be reminded if I have any classes on that particular day |
| `* *` | tutor | find timeslots when I am free | prevent schedle clashes when I add or edit a tutee's schedule |


### Use cases
Expand Down Expand Up @@ -1124,13 +1125,13 @@ Idea: Add a scheduling mechanism within the command execution to mark individual

Reason: To create a more sophisticated find feature for the best results. This enhancement allows users to get more specific results tailored to their criteria.

Idea: Modify the NameContainsKeywordsPredicate and SubjectContainsKeywordsPredicate to accept multiple word inputs (e.g. "find n/Alex Yeoh sb/Maths Chemistry).
Idea: Modify the `NameContainsKeywordsPredicate` and `SubjectContainsKeywordsPredicate` to accept multiple word inputs (e.g. "find n/Alex Yeoh sb/Maths Chemistry).

### Maximum PayRate

Reason: PayRate that are extremely high may not be displayed properly by GUI and are unlikely to be realistic PayRates per hour anyway.
Reason: `PayRate` that are extremely high may not be displayed properly by GUI and are unlikely to be realistic PayRates per hour anyway.

Idea: Modify the VALIDATION_REGEX of PayRate such that it only accepts values up to 9999.99.
Idea: Modify the VALIDATION_REGEX of `PayRate` such that it only accepts values up to 9999.99.

### Prevent Commands meant to Modify Tutee Data from Not Changing the Data

Expand Down Expand Up @@ -1164,3 +1165,8 @@ system should allow the edit to happen.
Reason: Users might be able to put in an infinitely-long phone number and email which may cut off the UI

Idea: Add the restriction in the parsers.

### UI Enhancements when minimizing the window size
Reason: When the window is minimized, both the schedule list panel and the tutee list panel might be cut off.

Idea: Set a minimum width for the Main Window to ensure the UI is not cut off.

0 comments on commit b59b766

Please sign in to comment.