Skip to content

Commit

Permalink
Update Ha Duong responsibilities in UG, DG and README
Browse files Browse the repository at this point in the history
  • Loading branch information
@dohaduong
dohaduong committed Mar 16, 2023
1 parent 62dee9f commit acdfc02
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 21 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Features
* Reminder and notifications:
- Set remainder for upcoming deadlines
- Get notified as soon as you open the app
* Job scheduling :
- Schedule jobs for each day
* Timetable:
- Displays timetable for the week specified by users
* Stats dashboard:
- List all jobs
- Show total number of jobs
Expand Down
2 changes: 1 addition & 1 deletion docs/AboutUs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[github](https://github.com/dohaduong)]

* Role: Developer
* Responsibility: Scheduling and timetable function
* Responsibility: Timetable function

### Chen Zuo Hui

Expand Down
45 changes: 29 additions & 16 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,20 +275,21 @@ _{Explain here how the data archiving feature will be implemented}_

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-------------------------------------------------------------------|--------------------------------|------------------------------------------------------------------------|
| `* * *` | new delivery driver and Duke Driver user | see usage instructions | refer to instructions when I forget how to use the App |
| `* * *` | delivery driver | add/delete jobs | keep track of my upcoming and old jobs |
| `* * *` | delivery driver | mark/unmark jobs | keep track of completed jobs |
| `* * *` | delivery driver | add a new person | keep in touch with my clients |
| `* * *` | delivery driver | delete a person | remove entries that I no longer need |
| `* * *` | organised delivery driver | find a person by name | locate details of persons without having to go through the entire list |
| `* * *` | forgetful person | be reminded of upcoming tasks and deadlines | complete all my jobs on time |
| `* *` | busy person | be reminded of my next task | focus on my current task and not remember too much stuff |
| `* *` | delivery driver | hide private contact details | minimize chance of someone else seeing them by accident |
| `* *` | delivery driver who wants to learn how to maximise his earnings | view my aggregated information | track my earnings and other statistics |
| `*` | delivery driver with many customers in the address book | sort persons by name | locate a person/client easily and thus increase delivery efficiency |
| `*` | user | adjust how my notifications are shown | have a clutter free desktop |
| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------------------------------------------------------|---------------------------------------------|------------------------------------------------------------------------|
| `* * *` | new delivery driver and Duke Driver user | see usage instructions | refer to instructions when I forget how to use the App |
| `* * *` | delivery driver | add/delete jobs | keep track of my upcoming and old jobs |
| `* * *` | delivery driver | mark/unmark jobs | keep track of completed jobs |
| `* * *` | delivery driver | add a new person | keep in touch with my clients |
| `* * *` | delivery driver | delete a person | remove entries that I no longer need |
| `* * *` | organised delivery driver | find a person by name | locate details of persons without having to go through the entire list |
| `* * *` | forgetful person | be reminded of upcoming tasks and deadlines | complete all my jobs on time |
| `* * *` | organised user | be reminded of upcoming tasks and deadlines | complete all my jobs on time |
| `* *` | busy person | view timetable of my tasks in a week | organise my timetable and complete everything on time |
| `* *` | delivery driver | hide private contact details | minimize chance of someone else seeing them by accident |
| `* *` | delivery driver who wants to learn how to maximise his earnings | view my aggregated information | track my earnings and other statistics |
| `*` | delivery driver with many customers in the address book | sort persons by name | locate a person/client easily and thus increase delivery efficiency |
| `*` | user | adjust how my notifications are shown | have a clutter free desktop |

*{More to be added}*

Expand Down Expand Up @@ -357,16 +358,28 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli


<details>
<summary><b>[TT1] Display timetable and scheduling tasks</b></summary>
<summary><b>[TT1] Display timetable and scheduling tasks of current week</b></summary>
<pre>
<b>MSS</b>
1. User requests to display timetable by selecting Timetable option on homepage.
2. System displays timetable of uncompleted/upcoming jobs.
2. System displays timetable of uncompleted/upcoming jobs in current week.
Use case ends.

</pre>
</details>

<details>
<summary><b>[TT2] Display timetable and scheduling tasks of specific week</b></summary>
<pre>
<b>MSS</b>
1. User requests to display timetable of specific week by requesting to show timetable of a date in that week.
2. System displays timetable of uncompleted/upcoming jobs in the week.
Use case ends.

</pre>
</details>


<details>
<summary><b>[RE1] Receive reminders</b></summary>
<pre>
Expand Down
23 changes: 21 additions & 2 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Duke Driver is a desktop app for managing delivery jobs and contacts. If you are
* Get notified as soon as you open the app
* Timetable:
* Linked with list of jobs
* Display timetable of all scheduled/upcoming jobs
* Sort job list by date and slot
* Display timetable of all scheduled/upcoming jobs in the week
* Stats dashboard:
* List all jobs
* Show total number of jobs
Expand Down Expand Up @@ -175,7 +176,7 @@ Format: `add_reminder d/DESCRIPTION time/YYYY-MM-DD HH:mm`
Examples:
* `add_reminder` followed by `d/Submit homework time/2023-12-12 12:00` adds a reminder that will remind the user to submit their homework. The reminder will occur at 12pm, 12 December 2023.

### Delete a reminder : `delete_reminder`
### Deleting a reminder : `delete_reminder`

Deletes a reminder into the address book.

Expand All @@ -188,6 +189,24 @@ Format: `delete_reminder INDEX`
Examples:
* `list_reminder` followed by `delete_reminder 2` deletes the 2nd reminder in the address book.

### Showing timetable : `timetable`

Shows timetable of jobs, with the week shown being current week.

Format: `timetable`

### Showing timetable of specific date: `timetable date/`

Shows timetable of specific week containing a specific date

Format: `timetable date/YYYY-mm-DD`

* Shows timetable of the week containing the given date

Examples:
* `timetable` followed by `2023-03-16` shows timetable of jobs in week from 13th - 19th March 2023.


### Clearing all entries : `clear`

Clears all entries from the address book.
Expand Down

0 comments on commit acdfc02

Please sign in to comment.