Skip to content

Commit e56eb16

Browse files
authored
Merge pull request #196 from getsquared/update-dg
Add Remark Use Case and Update Planned Enhancements
2 parents aa7348d + 544b40d commit e56eb16

File tree

1 file changed

+27
-11
lines changed

1 file changed

+27
-11
lines changed

docs/DeveloperGuide.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
515515
| `*` | manager | view all my subordinates' clients | be aware of their progress and client base |
516516
| `*` | insurance agent | get reminders of client birthday | send birthday message |
517517

518-
*{More to be added}*
519518

520519
### Use cases
521520

@@ -648,12 +647,29 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
648647
* 1b1. ClientCare lets user know that the list is empty.<br>
649648
Use case ends.
650649

651-
**Use case: UC07 - Adding remark to client**
650+
**Use case: UC07 - Adding notes to a client**
652651

653652
**MSS**
654-
1. PLACEHOLDER
653+
1. User requests to <u>list all clients (UC04)</u> or <u>find client by name (UC06)</u>.
654+
2. ClientCare shows a list of clients.
655+
3. User requests to add a note to a specific client in the list by index.
656+
4. ClientCare adds a note to the client.<br>
657+
5. ClientCare shows the client's details and success message to the user.<br>
658+
Use case ends.
655659

656660
**Extensions**
661+
* 2a. User sees that the list is empty.
662+
* 2a1. User stops as there is no client to add a note to.
663+
Use case ends.
664+
* 3a. ClientCare detects that the given command is invalid.
665+
* 3a1. ClientCare shows an error message.
666+
* 3a2. ClientCare requests for the correct input.
667+
* 3a3. User enters new data.<br>
668+
Steps 3a1-3a3 are repeated until the data entered are correct.<br>
669+
Use case resumes at step 4.
670+
* 3b. ClientCare detects that the client does not exist.
671+
* 3b1. ClientCare shows an error message.<br>
672+
Use case ends.
657673

658674

659675
**Use case: UC08 - Clear all client**
@@ -1239,14 +1255,14 @@ testers are expected to do more *exploratory* testing.
12391255

12401256
Team Size: 4
12411257

1242-
1. **Feature Flaw** - Currently, users can only schedule one appointment per client. In future versions, we will support multiple appointments per client.
1243-
2. **Feature Flaw** - Currently, names are case-sensitive. `John` and `john` are regarded as different clients. In future versions, names will be case-insensitive.
1244-
3. **Feature Flaw** - Currently, tags only allow alphanumeric values. Spaces and special characters are not allowed. In future versions, we will support the use of spaces and special characters for tags.
1245-
4. **Feature Flaw** - Currently, users are not allowed to use special characters like `/` when adding or editing the client name. In future versions, we will support the use of special characters like `/` for names.
1246-
5. **Feature Flaw** - Currently, users must fulfill all compulsory parameters to add a client. In future versions, we will make more parameters optional.
1247-
6. **Feature Flaw** - Currently, users must re-sort the client list after adding, editing or updating clients. Client List does not auto update or re-sort itself upon adding/editing or updating. In future versions, we will support the auto sorting when clients are updated.
1248-
7. **UI Bug** - Currently, the policy name and policy id may get truncated if there are too many characters. In future versions, we will support the wrapping of fields in the Policy Display.
1249-
8. **UI Bug** - Currently, the phone number and remark may get truncated if they are too long. In future versions, we will support the wrapping of all fields in the Client View Display.
1258+
1. **Add Scheduling Multiple Appointments Per Client** - Currently, users can only schedule one appointment per client. In future versions, we will support multiple appointments per client.
1259+
2. **Make Names Case-insensitive** - Currently, names are case-sensitive. `John` and `john` are regarded as different clients. In future versions, names will be case-insensitive.
1260+
3. **Allow Special Characters For Tags** - Currently, tags only allow alphanumeric values. Spaces and special characters are not allowed. In future versions, we will support the use of spaces and special characters for tags.
1261+
4. **Allow Special Characters For Names** - Currently, users are not allowed to use special characters like `/` when adding or editing the client name. In future versions, we will support the use of special characters like `/` for names.
1262+
5. **Make Parameters For Adding Clients Optional** - Currently, users must fulfill all compulsory parameters to add a client. In future versions, we will make more parameters optional.
1263+
6. **Retain Sorting Order After Commands** - Currently, users must re-sort the client list after adding, editing or updating clients. Client List does not auto update or re-sort itself upon adding/editing or updating. In future versions, we will support the auto sorting when clients are updated.
1264+
7. **Fix Text Truncation In Policy Table** - Currently, the policy name and policy id may get truncated if there are too many characters. In future versions, we will support the wrapping of fields in the Policy Display.
1265+
8. **Fix Text Truncation In Client Details** - Currently, the name, tags, phone number, address, email and remark may get truncated if they are too long. In future versions, we will support the wrapping of all fields in the Client View Display.
12501266

12511267
--------------------------------------------------------------------------------------------------------------------
12521268

0 commit comments

Comments
 (0)