diff --git a/README.md b/README.md index 5ef3015c941..3e3ce857671 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 08ff9cc20b3..dd4e2728e60 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -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 diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 2034a840834..fd82dfe43b9 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -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}* @@ -357,16 +358,28 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
-[TT1] Display timetable and scheduling tasks +[TT1] Display timetable and scheduling tasks of current week 
 MSS
 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.
+
+[TT2] Display timetable and scheduling tasks of specific week +
+MSS
+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.
+
+
+
+ +
[RE1] Receive reminders 
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 536f0687eda..5fe58c9aa36 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -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
@@ -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.
 
@@ -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.