Skip to content

Commit c38ea47

Browse files
authored
Merge pull request #225 from zzkzzzz/branch-final
Update readme and DG NFR
2 parents 8eb9c6d + 864ba29 commit c38ea47

File tree

3 files changed

+19
-21
lines changed

3 files changed

+19
-21
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,18 @@
55
![Ui](docs/images/Ui.png)
66

77

8-
* The application is no different than normal mobile contact applications. Our application, targeted towards insurance agents, will ease them in storing their customer's information.
8+
* This application, targeted towards insurance agents, will ease them in managing their customer's information, insurances, records and appointments.
9+
10+
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
11+
* It comes with a **reasonable level of user and developer documentation**.
912

10-
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
11-
* It comes with a **reasonable level of user and developer documentation**.
13+
* Usages:
14+
- Management of clients
15+
- Management of insurances
16+
- Management of records
17+
- Management of appointments
1218

13-
* Features:
14-
- Customizable insurance and client categories
15-
- Connections between customers
16-
- Client’s insurance contract → end date, price, company
17-
- Advanced search (by location, contract, date, company etc)
18-
- Appointment (todo) → when list out can sort by date
19-
- Transaction/contract
20-
- Contacts become inactive after a specific period
19+
For more information on how to get started, check out the **[Mr. Agent User Guide](https://ay2122s2-cs2103-f09-4.github.io/tp/UserGuide.html)**.
2120

2221

23-
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
22+
Acknowledgement: This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

docs/DeveloperGuide.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ Step 5. `MainWindow` will update the `AppointmentListPanel` to show the appointm
433433
* prefers typing to mouse interactions
434434
* is reasonably comfortable using CLI apps
435435

436-
**Value proposition**: manage clients and appointments faster than a typical mouse/GUI driven app
436+
**Value proposition**: manage clients, insurances, records and appointments faster than a typical mouse/GUI driven app
437437

438438

439439
### <a id="userStories"></a>User stories
@@ -567,16 +567,15 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
567567

568568
Use case resumes at step 1.
569569

570-
*{More to be added}*
571570

572571
### <a id="Non-Functional"></a>Non-Functional Requirements
573572

574-
1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
575-
2. Should be able to hold up to 1000 clients without a noticeable sluggishness in performance for typical usage.
576-
3. 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.
577-
4. No network connection needed.
578-
579-
*{More to be added}*
573+
1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
574+
2. Should be able to hold up to 1000 clients without a noticeable sluggishness in performance for typical usage.
575+
3. 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.
576+
4. No network connection needed.
577+
6. The source code should be open source.
578+
7. The user interface should be intuitive enough for users who are not IT-savvy.
580579

581580
### <a id="Glossary"></a>Glossary
582581

src/main/java/seedu/address/ui/HelpWindow.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
public class HelpWindow extends UiPart<Stage> {
1717

1818
public static final String USERGUIDE_URL =
19-
"https://ay2122s2-cs2103-f09-3.github.io/tp/UserGuide.html#delete-insurance";
19+
"https://ay2122s2-cs2103-f09-3.github.io/tp/UserGuide.html";
2020
public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;
2121

2222
private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);

0 commit comments

Comments
 (0)