diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 401ec7f1ee7..26bb97aad1d 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -47,12 +47,12 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Developer -### James Doe +### Gabriel Seethor Jun Hao - + -[[github](http://github.com/johndoe)] -[[portfolio](team/johndoe.md)] +[[github](http://github.com/gabriel4357)] +[[portfolio](team/gabriel4357.md)] -* Role: Developer -* Responsibilities: UI +* Role: Scheduling and Tracking +* Responsibilities: In charge of defining, assigning, and tracking project tasks. diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 343daa399b9..b5e6818fb7d 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -4,7 +4,7 @@ title: "Developer Guide" pageNav: 3 --- -# AB-3 Developer Guide +# HomeBoss Developer Guide @@ -330,13 +330,18 @@ _{Explain here how the data archiving feature will be implemented}_ **Target user profile**: -* has a need to manage a significant number of contacts +* has a home business +* want to oversee customers in an organised manner +* want to manage deliveries efficiently and effectively * prefer desktop apps over other types * can type fast * prefers typing to mouse interactions * is reasonably comfortable using CLI apps -**Value proposition**: manage contacts faster than a typical mouse/GUI driven app +**Value proposition**: +Home-based business owners can have a huge base of customers. +HomeBoss streamlines and simplifies the management of customer contacts and deliveries, +thereby improving efficiency for business owners. ### User stories @@ -427,9 +432,17 @@ otherwise) ### Non-Functional Requirements 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. -2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. -3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be +2. Should be able to hold up to + 1. 1000 customers without a noticeable sluggishness in performance for typical usage. + 2. 1000 deliveries without a noticeable sluggishness in performance for typical usage. +3. The system should be easily picked up by a novice with no experience with contact management software. +4. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. +5. Data stored should be persistent until removal by user, and Private Contact Details should be secure. +6. The project is expected to adhere to a schedule which delivers a feature set every milestone up to _V1.3_ +7. The application is not expected to + 1. Perform Inventory Management + 2. Perform Route Planning *{More to be added}* diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 517b96d28e3..92305f24b36 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -182,7 +182,7 @@ _ADDRESS_: String _CUSTOMER_ID_: Integer -\*At least one of the optional fields must be provided. +*At least one of the optional fields must be provided. **Command succeeds:** _Customer 1, Gabriel has been updated!_ @@ -248,21 +248,17 @@ Shows a list of all deliveries. **Accepted Values:** -_ STATUS_: all or pending or complete +_STATUS_: String of either `all` or `pending` or `complete` - _SORT: _asc for ascending or desc for descending. If unspecified, default to sort by delivery date. +_SORT_: String of either `asc` for ascending or `desc` for descending or empty string for sorting by delivery date -**Command succeeds (>0 deliveries):** +**Command succeeds (>0 deliveries):** _Here are all the deliveries:_ -_Here are all the deliveries:_ +1. _[1001] Gabriel’s Milk - Completed - Ordered 20th Sept 2023 : Delivered on 30th Sept 2023_ +2. _[1002] Gambe’s Meat - Completed - Ordered 22th Sept 2023 : Delivered on 29th Sept 2023_ +3. _[1003] Ben’s Coffee - Pending - Ordered 25th Sept 2023 : Delivery on 1st October 2023_ -1. [1001] Gabriel’s Milk - Completed - Ordered 20th Sept 2023 : Delivered on 30th Sept 2023 -2. [1002] Gambe’s Meat - Completed - Ordered 22th Sept 2023 : Delivered on 29th Sept 2023 -3. [1003] Ben’s Coffee - Pending - Ordered 25th Sept 2023 : Delivery on 1st October 2023 - -**Command failed (0 deliveries): ** - -_There are currently no deliveries!_ +**Command failed (0 deliveries):** _There are currently no deliveries!_ ### View details of deliveries @@ -278,24 +274,14 @@ _DELIVERY_ID_: Integer **Command succeeds:** - _[1001] Gabriel’s Milk_ - - - _Customer ID: 1_ - - - _Customer: Gabriel_ - - - _Ordered on : 23rd September 2023_ - +_[1001] Gabriel’s Milk_
+_Customer ID: 1_
+_Customer: Gabriel_
+_Ordered on : 23rd September 2023_
+_Delivery Status: Pending_
+_Delivery on : 1st October 2023_ - _Delivery Status: Pending_ - - - _Delivery on : 1st October 2023_ - -**Command failed (0 deliveries): _There are currently no deliveries. _** +**Command failed (0 deliveries):** _There are currently no deliveries._ ### Update delivery status and date @@ -305,78 +291,77 @@ _DELIVERY_ID_: Integer #### Mark delivery as complete -#### **Format**: `delivery complete DELIVERY_ID` +**Format**: `delivery complete DELIVERY_ID` **Example**: `delivery complete 1001` **Accepted Values:** - _DELIVERY_ID_: Integer +_DELIVERY_ID:_ Integer -**Command succeeds:** _Delivery [1001] Gabriel’s Milk marked as pending! _ +**Command succeeds:** _Delivery [1001] Gabriel’s Milk marked as complete!_ -**Command failed (delivery*name missing): \_Please specify a delivery name to delete!*** +**Command failed (delivery_name missing):** _Please specify a delivery name!_ **Command failed (delivery_name not in database):** _This delivery does not seem to exist!_ -**Command failed (delivery already complete): _This delivery is already marked as complete._** +**Command failed (delivery already complete):** _This delivery is already marked as complete._ #### Mark delivery as pending **Format:** `delivery pending DELIVERY_ID` -**Example: `delivery pending 1001`** +**Example:** `delivery pending 1001` **Accepted Values:** _DELIVERY_ID_: Integer -**Command succeeds:** _Delivery [1001] Gabriel’s Milk marked as pending! _ +**Command succeeds:** _Delivery [1001] Gabriel’s Milk marked as pending!_ -**Command failed (delivery_name missing):** _Please specify a delivery name to delete!_ +**Command failed (delivery_name missing):** _Please specify a delivery name!_ -**Command failed (delivery_name not in database):** _This delivery does not seem to exist! _ +**Command failed (delivery_name not in database):** _This delivery does not seem to exist!_ -**Command failed (delivery already pending): _This delivery is already marked as pending._** +**Command failed (delivery already pending):** _This delivery is already marked as pending._ #### Change date of delivery -**Format**: `delivery edit date DELIVERY_ID --date DATE` +**Format:** `delivery edit date DELIVERY_ID --date DATE` -**Example**: `delivery edit date 1001 --date 2023-12-12` +**Example:** `delivery edit date 1001 --date 2023-12-12` **Accepted Values:** - _DELIVERY_ID_: Integer - +_DELIVERY_ID:_ Integer - _DATE: _YYYY-MM-DD +_DATE:_ String of format YYYY-MM-DD -**Command succeeds:** _Delivery [1001] Gabriel’s Milk changed delivery date to 1st Oct 2023! _ +**Command succeeds:** _Delivery [1001] Gabriel’s Milk changed delivery date to 1st Oct 2023!_ -**Command failed (one field missing): _Please specify a delivery name and date!_** +**Command failed (one field missing):** _Please specify a delivery name and date!_ -**Command failed (invalid date format): _Please format date as YYYY-MM-DD. _** +**Command failed (invalid date format):** _Please format date as YYYY-MM-DD._ -**Command failed (delivery*name not in database): \_This delivery does not seem to exist! *** +**Command failed (delivery_name not in database):** _This delivery does not seem to exist!_ ### Delete delivery Deletes the specified delivery. -**Format**: `delivery delete DELIVERY_ID` +**Format:** `delivery delete DELIVERY_ID` -**Example**: `delivery delete 1001` +**Example:** `delivery delete 1001` **Accepted Values:** _DELIVERY_ID_: Integer -**Command succeeds:** _Delivery [1001] Gabriel’s Milk deleted! _ +**Command succeeds:** _Delivery [1001] Gabriel’s Milk deleted!_ **Command failed (delivery_name missing):** _Please specify a delivery name to delete!_ -**Command failed (delivery*name not in database): \_This delivery does not seem to exist*** +**Command failed (delivery_name not in database):** _This delivery does not seem to exist!_ ### Create a note for a delivery `[Coming Soon in v1.3]` diff --git a/docs/images/gabriel4357.png b/docs/images/gabriel4357.png new file mode 100644 index 00000000000..e42445d3c38 Binary files /dev/null and b/docs/images/gabriel4357.png differ diff --git a/docs/team/gabriel4357.md b/docs/team/gabriel4357.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md deleted file mode 100644 index 86aa7ebfc34..00000000000 --- a/docs/team/johndoe.md +++ /dev/null @@ -1,46 +0,0 @@ ---- - layout: default.md - title: "John Doe's Project Portfolio Page" ---- - -### Project: AddressBook Level 3 - -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. - -Given below are my contributions to the project. - -* **New Feature**: Added the ability to undo/redo previous commands. - * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. - * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. - * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. - * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* - -* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. - -* **Code contributed**: [RepoSense link]() - -* **Project management**: - * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub - -* **Enhancements to existing features**: - * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) - * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) - -* **Documentation**: - * User Guide: - * Added documentation for the features `delete` and `find` [\#72]() - * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() - * Developer Guide: - * Added implementation details of the `delete` feature. - -* **Community**: - * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() - * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) - * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) - * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) - -* **Tools**: - * Integrated a third party library (Natty) to the project ([\#42]()) - * Integrated a new Github plugin (CircleCI) to the team repo - -* _{you can add/remove categories in the list above}_ diff --git a/docs/team/zhonghan721.md b/docs/team/zhonghan721.md index feaebc6cd56..7f1e1c43d03 100644 --- a/docs/team/zhonghan721.md +++ b/docs/team/zhonghan721.md @@ -5,8 +5,8 @@ ### Project: HomeBoss -HomeBoss is a desktop application used for managing deliveries for home business owners. -The user interacts with it using a CLI, and it has a GUI created with JavaFX. +HomeBoss is a desktop application used for managing deliveries for home business owners. +The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. Given below are my contributions to the project.