[v1.4][F11-B2] TuitionCor #64
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| = TuitionCor - Developer Guide | ||
| :toc: | ||
| :toc-title: | ||
| :toc-placement: preamble | ||
|
|
@@ -10,7 +10,7 @@ ifdef::env-github[] | |
| :tip-caption: :bulb: | ||
| :note-caption: :information_source: | ||
| endif::[] | ||
| :repoURL: https://github.com/CS2103JAN2018-F11-B2/main forked from Team SE-EDU | ||
|
There was a problem hiding this comment. Provide link to the Team SE-EDU repo too |
||
|
|
||
| By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` | ||
|
There was a problem hiding this comment. Update this line! Preferably |
||
|
|
||
|
|
@@ -160,7 +160,7 @@ image::UiClassDiagram.png[width="800"] | |
|
|
||
| *API* : link:{repoURL}/src/main/java/seedu/address/ui/Ui.java[`Ui.java`] | ||
|
|
||
| The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class. | ||
|
There was a problem hiding this comment. Missing documentation for new features, please remember to add them every week. |
||
|
|
||
| The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`] | ||
|
|
||
|
|
@@ -782,13 +782,25 @@ See this https://github.com/se-edu/addressbook-level4/pull/599[PR] for the step- | |
|
|
||
| *Target user profile*: | ||
|
|
||
| <<<<<<< Updated upstream | ||
|
|
||
| * Tuition coordinators who are comfortable with CLI applications | ||
| ======= | ||
| * A tuition service agent that receive calls from both tutor and students asking for assignments. | ||
| * has a need to manage a significant number of clients. | ||
| * prefer desktop apps over other types | ||
| * can type fast | ||
| * prefers typing over mouse input | ||
| * is reasonably comfortable using CLI apps | ||
| >>>>>>> Stashed changes | ||
|
|
||
| *Value proposition*: | ||
| TuitionCor is targeted at tuition coordinators who have to manage a large amount of contacts. | ||
| The daily job-scope of a tuition coordinator involves the need to manage large amount of contacts and match the students to tutors according to their credentials, needs and location. | ||
|
|
||
| Therefore, TuitionCor aims to facilitate this process and make the job of a tuition coordinator easier. | ||
|
|
||
| In addition, users are able to | ||
| * find and filter contacts easily | ||
| * add and edit contacts | ||
|
|
||
| [appendix] | ||
| == User Stories | ||
|
|
@@ -800,18 +812,63 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un | |
| |Priority |As a ... |I want to ... |So that I can... | ||
| |`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App | ||
|
|
||
| |`* * *` |user |add a new person (tutor or student) |expand user's addressbook for future tuition coordination | ||
|
|
||
| |`* * *` |user |delete a person |remove entries that the user no longer need | ||
|
|
||
|
There was a problem hiding this comment. The target user profile is not updated. Please update it so I can assess its viability or make suggestions for improvements. |
||
| |`* * *` |user |find a person by name |locate details of persons without having to go through the entire list | ||
|
|
||
| |`* * *` |user |sort contacts based on the clients' location (North, South, East, West, Central |better match students and tutors that are staying near each other. | ||
|
|
||
| |`* * *` |user |edit the information stored |keep the information up to date | ||
|
|
||
| |`* * *` |user |tag tutors and students with multiple fields |do multi-layer searching to better match tutors and students | ||
|
|
||
| |`* * *` |user |categorise contacts between students and tutors |reduce the number of tagging required and make searching more convenience | ||
|
|
||
|
|
||
| |`* * *` |user |group clients based on the subject they wish to study/teach (Math, Eng, Phy, Chem...) |find and match client easily by the subjects registered | ||
|
|
||
| |`* * *` |user |record the gender preference the students/tutors have (male/female) |find and match client easily by the gender preference registered | ||
|
|
||
| |`* * *` |user |see and compare the price that students/tutors are willing to pay/accept|match them based on pricing | ||
|
|
||
| |`* * *` |user |have an auto-save function |changes will be saved once user exit the application | ||
|
There was a problem hiding this comment. This does not seem to fit into a user story - this seems to be out of the control of the user (since it's automatic after all) and would be more suited as a NFR |
||
|
|
||
| |`* * *` |user |search by tags added to client |generate a list of clients that have the same tags | ||
|
|
||
| |`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident | ||
|
|
||
| |`* *` |user |search multiple tags |narrow down the search to clients that fit all the different tags searched. | ||
|
|
||
| |`* *` |user |easily delete all students/tutors |save time manually deleting | ||
|
|
||
| |`* *` |user |get a list of all tutors that corresponds to a students requirements |give students more choices on which tutor they want | ||
|
|
||
| |`* *` |user |get a list of all students that corresponds to a tutor's requirements |give tutors more choices on which students they want | ||
|
|
||
| |`* *` |user |automatically update the year of all students |need not manually change all the information during new year | ||
|
|
||
| |`* *` |user |update which time slot the tutor is already working |plan their timetable without any clash in timing | ||
|
|
||
| |`* *` |user |have a ranking on how good the tutor is |understand which tutor the user should recommend more | ||
|
|
||
| |`* *` |user |highlight urgent tuition requests |set reminder to place more attention on these assignments | ||
|
|
||
| |`* *` |user |blacklist certain tutors or students |make sure the user will not accept their assignments | ||
|
|
||
| |`* *` |user |have the option to customise the font size and colour |make changes to the appearance to suit the user's preference | ||
|
|
||
| |`* *` |user |have the option to customise the user's background |make the application more appealing to the user | ||
|
|
||
| |`* *` |user |email the contacts in the application |save the trouble from opening another web-browser or email application | ||
|
|
||
| |`* *` |user |keep track of whether the tutors have paid their agent fee |keep track and remind those who have not paid. | ||
|
|
||
| |`*` |user |directly navigate between contacts |save the trouble from returning to the main page every time | ||
|
|
||
| |`*` |user |keep a record of how much the students improve |keep track of how good the tutor is | ||
| |======================================================================= | ||
|
|
||
|
|
||
| [appendix] | ||
| == Use Cases | ||
|
|
@@ -844,16 +901,67 @@ Use case ends. | |
| + | ||
| Use case resumes at step 2. | ||
|
|
||
| [discrete] | ||
| === Use case: Sort by locality | ||
|
|
||
| *MSS* | ||
|
|
||
| 1. User types “/sortl” in to the command line. | ||
| 2. Addressbook will prompt user to select whether they would like to view the list for students or tutors. | ||
|
There was a problem hiding this comment. No longer |
||
| 3. User will enter either “s” for students or “t” for tutors. | ||
| 4. Addressbook will return a list of students or tutors based sorted by their locality. | ||
| + | ||
| Use case ends. | ||
|
|
||
| *Extensions* | ||
|
|
||
| [none] | ||
| * 3a. System detects an invalid input. | ||
| + | ||
|
There was a problem hiding this comment. Should there also be an extension for if the user wants to escape from the command input? (Such as if the user changes his mind after typing |
||
| [none] | ||
| ** 3a1. Addressbook request for either "s" or "t" to be inputted. | ||
| ** 3a2. User enter required information. | ||
| ** 3a3. Steps 3a1 and 3a2 are repeated until valid input is entered. | ||
| + | ||
| Use case resumes at step 4. | ||
|
|
||
| [discrete] | ||
| === Use case: Match | ||
|
|
||
| *MSS* | ||
|
|
||
| 1. User enter match followed by a person name. | ||
| 2. Addressbook displays information of client in the respective list (either tutor list or student list) | ||
| 4. Addressbook returns a list of potential matches in the respective list. | ||
| + | ||
| Use case ends. | ||
|
|
||
| *Extensions* | ||
|
|
||
| [none] | ||
| * 1a. Client cannot be found. | ||
| + | ||
| Use case ends. | ||
|
|
||
| * 3a. There is no match found. | ||
| + | ||
| [none] | ||
| ** 3a1. Addressbook returns an empty list. | ||
| + | ||
| Use case ends. | ||
|
|
||
|
There was a problem hiding this comment. Where are the other use cases for your enhancements? This is also part of documentation. @Zhu-Jiahui @shookshire @olimhc |
||
|
|
||
| [appendix] | ||
| == Non Functional Requirements | ||
|
|
||
| . Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `1.8.0_60` or higher installed. | ||
| . Should be able to hold up to 5000 persons without a noticeable sluggishness in performance for typical usage. | ||
| . 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. | ||
| . Application should be able execute any command within 3 seconds. | ||
| . Application should have a self-explanatory installation process. | ||
| . Application should be less than 5mb in size. | ||
|
|
||
| . Application is expected to allow printing. | ||
|
|
||
|
|
||
| [appendix] | ||
| == Glossary | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove/ replace these badges with your team's repo instead -- they are not badges for your updated application anymore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will update in my commit