Update Features Section in User Guide #34

iamdiluxedbutcooler · 2024-10-04T01:33:16Z

closes #33

v.1, only necessary details
need more explainations and examples for novice users

- v.1, only necessary details - need more explainations and examples for novice users

…xplaination

ZShunRen

Overall, great job translating our past meeting notes into an updated user guide. Take note of our changed ideas however.

ZShunRen · 2024-10-04T12:36:35Z

docs/UserGuide.md

+| income    | Non-negative integers                        | Only positive numbers or zero are valid for income fields. |
+
+#### What to Expect
+- **If Successful:** You'll see a message: "New Contact added. Their ID is `<new customer ID>`."


Since we are probably keeping their way of representing a contact and we are removing unique customer ids, this should be changed to New person added: <NAME>; Contact: <CONTACT NUMBER>; Email: <EMAIL>; Job: <JOB>; Income: <INCOME>; Tags: <TAGS>

Since Tag can be assigned only by the tag command, in add new customer case, should we just go by the Tag field N/A or just not show (cuz in use case the steps should be add new customer > the agent analyze > decide the tier)

ZShunRen · 2024-10-04T12:37:51Z

docs/UserGuide.md

+  - Missing name: "Customer requires a name."
+  - Incorrect email format: "Please give a valid email address."
+  - Invalid income entry: "Please use a non-negative number for income."


It is possible to do this, but we need multiple conditions when parsing the add command, which needs to be added.

Agreed, so we consider remove from MVP first right?

yes i believe that we should remove this from mvp

ZShunRen · 2024-10-04T12:38:50Z

docs/UserGuide.md

+  - Invalid income entry: "Please use a non-negative number for income."
+
+**Handling Duplicates:**  
+If a customer with the same name, email, job, and income is already saved, you'll get a message: "This customer is already saved as a contact. Their ID is `<new customer ID>`."


Same thing here, probably remove the part with the customer id. "If a customer with the same name, email, job, and income is already saved, you'll get a message: "This customer is already saved as a contact." should suffice.

ZShunRen · 2024-10-04T12:40:46Z

docs/UserGuide.md

+#### Parameters
+| Parameter | Expected Format             | Explanation                                         |
+|-----------|-----------------------------|-----------------------------------------------------|
+| ID        | Integer (0 to the last ID)  | The ID must be a valid integer within the registered range. |


I think we can clarify that the ID, is of the customer in either

The original list or

Any filtered list after using the filter command

ZShunRen · 2024-10-04T12:41:16Z

docs/UserGuide.md

+#### Parameters
+| Parameter | Expected Format             | Explanation                                         |
+|-----------|-----------------------------|-----------------------------------------------------|
+| ID        | Integer (0 to the last ID)  | The ID must be a valid integer within the registered range. This ensures you can view details for an existing customer. |


Same thing for the ID explanation above

ZShunRen · 2024-10-04T12:53:44Z

docs/UserGuide.md

+note <customer id> <note here>
+```
+- **Example:** 
+```
+note 55 He is a problematic customer.


I would suggest changing note to remark so we don't have to refactor the command.

ZShunRen · 2024-10-04T12:54:13Z

docs/UserGuide.md

+  - Message: "Note has been added to Customer `<Customer ID>`."
+- **If There is an Error:** 
+  - Invalid ID: "No customer with `<Customer ID>` exists. Please input a valid ID."


See above, replace note and the id instruction.

ZShunRen · 2024-10-04T12:54:37Z

docs/UserGuide.md

+**Handling Duplicates:**  
+- Although customer IDs should be unique, in the rare case where duplicates are detected, the following error message will be shown:
+  - "Sorry, it appears that multiple customers with id: `<Customer ID>` exist. Please use the delete command to remove the duplicated customer ID."


I think this part should be cut, since we have scrapped this idea.

ZShunRen · 2024-10-04T12:55:33Z

docs/UserGuide.md

+tag <customer id> <tier>
+```
+- **Example:** 
+```
+tag 69 reject


I like this idea, but we will have to refactor the tags now to mean credit card tiers.

ZShunRen · 2024-10-04T12:56:16Z

docs/UserGuide.md

+#### What to Expect
+- **If Successful:** 
+  - The message "Terminating program…" is displayed.
+  - The program will then exit after a short delay, effectively closing the application.


This feature will have to be added.

ZShunRen · 2024-10-05T07:06:20Z

docs/UserGuide.md

+**How to Use It:**  
+- **Command Format:** 
+```
+tag <INDEX> <TIER>


standardise tag t/

ZShunRen · 2024-10-05T07:10:59Z

docs/UserGuide.md

+| **Find a Customer by Details**  | `filter /<FLAG> <FLAG FIELD>`                                                                | `filter /n TAN LESHEW`                                                      |
+| **Save Remarks About Customers**| `remark <INDEX> r/ <REMARK>`                                                                 | `remark 55 He is a problematic customer.`                                   |
+| **Add/Replace Credit Card Tier**| `tag <INDEX> t/ <TIER>`                                                                      | `tag 69 reject`                                                             |


should be n/ and or missing r/

ZShunRen · 2024-10-05T07:12:15Z

docs/UserGuide.md

+| **Remove Old Customer**         | `del <INDEX>`                                                                                | `del 69`                                                                                      |
+| **View Details of a Customer**  | `view <INDEX>`                                                                               | `view 69`                                                                                     |
+| **Edit Existing Customer**      | `edit <INDEX> n/<NAME> p/<PHONE> e/<EMAIL> a/<ADDRESS> j/<JOBNAME> i/<INCOME> [t/<TAG>]`     | `edit 69 n/TAN LESHEW p/77337733 e/[email protected] a/COM3 j/doctor i/1000000000`                 |
+| **Find a Customer by Details**  | `filter /<FLAG> <FLAG FIELD>`                                                                | `filter /n TAN LESHEW`                                                                        |


filter / -> filter /
filter /n TAN LESHEW -> filter n/ TAN LESHEW

ZShunRen

LGTM

Update Features section in User Guide.

22686c3

- v.1, only necessary details - need more explainations and examples for novice users

iamdiluxedbutcooler added this to the v1.1 milestone Oct 4, 2024

iamdiluxedbutcooler self-assigned this Oct 4, 2024

Update Features section in User Guide: add more details for clearer e…

a031f79

…xplaination

ZShunRen approved these changes Oct 4, 2024

View reviewed changes

Update Features and Command Summary fields in UG

501e1e3

ZShunRen reviewed Oct 5, 2024

View reviewed changes

docs/UserGuide.md Outdated

**How to Use It:**

- **Command Format:**

```

tag <INDEX> <TIER>

Copy link

ZShunRen Oct 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

standardise tag t/

iamdiluxedbutcooler added 3 commits October 5, 2024 15:07

Update /r and /t in remark and tag command

8e01f26

Resolve r/ and t/ issue

f210983

Resolve r/ and t/ issue

7d92214

ZShunRen reviewed Oct 5, 2024

View reviewed changes

Fix the / issues

07834f9

ZShunRen approved these changes Oct 5, 2024

View reviewed changes

Merge branch 'master' into edit-ug-features

5f6e923

ZShunRen merged commit f7dec76 into AY2425S1-CS2103T-T14-4:master Oct 5, 2024
3 checks passed

ZShunRen mentioned this pull request Oct 5, 2024

Update Commands section in User Guide #29

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Features Section in User Guide #34

Update Features Section in User Guide #34

iamdiluxedbutcooler commented Oct 4, 2024 •

edited

Loading

ZShunRen left a comment

ZShunRen Oct 4, 2024

iamdiluxedbutcooler Oct 5, 2024

ZShunRen Oct 4, 2024

iamdiluxedbutcooler Oct 5, 2024

ZShunRen Oct 5, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 4, 2024

ZShunRen Oct 5, 2024

ZShunRen Oct 5, 2024

ZShunRen Oct 5, 2024 •

edited

Loading

ZShunRen left a comment

Update Features Section in User Guide #34

Update Features Section in User Guide #34

Conversation

iamdiluxedbutcooler commented Oct 4, 2024 • edited Loading

ZShunRen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZShunRen Oct 5, 2024 • edited Loading

Choose a reason for hiding this comment

ZShunRen left a comment

Choose a reason for hiding this comment

iamdiluxedbutcooler commented Oct 4, 2024 •

edited

Loading

ZShunRen Oct 5, 2024 •

edited

Loading