[v1.2][T11-B1] TuitionConnect

README.adoc

@@ -1,9 +1,9 @@
 = Address Book (Level 4)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
+https://travis-ci.org/CS2103JAN2018-T11-B1/main[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
 https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
+https://coveralls.io/github/CS2103JAN2018-T11-B1/main?branch=master[image:https://coveralls.io/repos/github/CS2103JAN2018-T11-B1/main/badge.svg?branch=master[Coverage Status]]
 https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
 https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
 

docs/DeveloperGuide.adoc

@@ -10,7 +10,7 @@ ifdef::env-github[]
 :tip-caption: :bulb:
 :note-caption: :information_source:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4/tree/master
+:repoURL: https://github.com/CS2103JAN2018-T11-B1/main
 
 By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
 
@@ -806,27 +806,71 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 
 |`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* * *` |tutor |list schedule I have in certain month |check and prepare myself in advance
+
+|`* * *` |tutor |add a new tuition schedule |so that I can compile my tuition schedule
+
+|`* * *` |user |delete a schedule in the calendar |update my calender
+
+|`* * *` |tutor |tag the students with their current education level |adjust my teaching accordingly
+
+|`* * *` |tutor |edit student's details |stay updated
+
+|`* * *` |user |edit a schedule |update my calendar
+
+|`* * *` |user |open the calender |check on my schedule
+
+|`* * *` |user |submit feedback to the developers of the application |this application can be further improved
+
+|`* * *` |user |add my personal schedule to the calendar |prevent any schedule from clashing
+
+|`* * *` |tutor |categorize a contact as my student |separate my student from my personal contact lists
+
+|`* *` |tutor |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+
+|`* *` |tutor |measure the retention rate of my tutoring service |improve on myself and use it as my tuition credential
+
+|`* *` |user |track my work hours over a specific interval of time |maintain a good work life balance
+
+|`* *` |user |receive payments for my services electronically |receive payment more conveniently
+
+|`* *` |tutor |track the tuition payment |know who has not paid
+
+|`* *` |tutor |integrate my calendar with the school's calendar |prevent clashes between tuition schedule and students' school commitment
+
+|`* *` |tutor with many students |send messages to all students that meet a certain description |inform students together and not one by one
+
+|`* *` |tutor |add subject grade of the students |keep track of his progress
+
+|`* *` |tutor |list students coming from the same school |so that I can gather and spread useful information among these students.
+
+|`* *` |tutor |list students based on their grades |give more tuition to students who are doing badly
+
+|`* *` |tutor |give assignments(done and to-be-done) to a student |track his work and progress easily
 
 |`*` |user with many persons in the address book |sort persons by name |locate a person easily
+
+|`*` |tutor |take note of the name of my student's school teachers |adjust my teaching according to the school teacher.
+
+|`*` |tutor |insert my student's photo |
 |=======================================================================
 
 _{More to be added}_
 
 [appendix]
 == Use Cases
 
-(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
+(For all use cases below, the *System* is the `Tuition Connect AddressBook (TC)` and the *Actor* is the `user`, unless specified otherwise)
 
 [discrete]
-=== Use case: Delete person
+=== Use case: UC01-Delete person
 
 *MSS*
 
 1.  User requests to list persons
-2.  AddressBook shows a list of persons
+2.  TC shows a list of persons
 3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+4.  TC deletes the person
 +
 Use case ends.
 
@@ -840,10 +884,147 @@ Use case ends.
 * 3a. The given index is invalid.
 +
 [none]
-** 3a1. AddressBook shows an error message.
+** 3a1. TC shows an error message.
 +
 Use case resumes at step 2.
 
+=== Use case: UC02 - Add a tuition schedule
+*MSS*
+
+1. User adds a schedule by providing the time (date & duration)
+2. TC asks whether user wants to *add a personal schedule(UC03)* or a tuition schedule.
+3. User chooses tuition schedule
+4. TC asks the name of the tutee
+5. User types the name of the tutee
+6. TC confirms that process is done.
++
+Use Case ends.
+
+*Extensions*
+
+[none]
+* 1a. Clashing schedule
++
+[none]
+** 1a1. TC reports that schedule clashes and requests a new timing.
+** 1a2. User enters a new schedule
+** Steps 1a1.-1a2. are repeated until there is no clash.
+** Use case resumes from Step 2.
+
+* *a. At any time, user can cancel adding the schedule.
+[none]
+** *a1 TC requests confirmation of the cancelation.
+** *a2. User confirms the cancellation.
+** Use case ends.
+
+* 5a. Name is not found
++
+[none]
+** 5a1. TC requests user to retype the tutee’s name.
+** 5a2. User retypes the tutee’s name.
+** Steps 5a1.-5a2. are repeated until a valid name is provided.
+** Use case resumes from Step 6.
+
+* *a. At any time, user can cancel adding the schedule.
+[none]
+** *a1 TC requests confirmation of the cancelation.
+** *a2. User confirms the cancellation.
+       	Use case ends.
+
+=== Use case: UC03 - Add a personal schedule
+*MSS*
+
+1. User adds a schedule by providing the time (date & duration)
+2. TC asks whether user wants to add a personal schedule or to **add a tuition schedule(UC02)**.
+3. User chooses personal schedule
+4. TC prompts user to fill in a description.
+5. User fills in the description.
+6. TC confirms that process is done.
++
+Use Case ends.
+
+*Extension*
+
+[none]
+* 1a. Clashing schedule
++
+[none]
+** 1a1. TC reports that schedule clashes and requests a new timing.
+** 1a2. User enters a new schedule
+** Steps 1a1.-1a2. are repeated until there is no clash.
+** Use case resumes from Step 2.
+
+* *a. At any time, user can cancel adding the schedule.
+[none]
+** *a1 TC requests confirmation of the cancelation.
+** *a2. User confirms the cancellation.
+** Use case ends.
+
+=== Use case: UC04 - Set a contact as a tutee
+*MSS*
+
+1. User requests to set a contact as a new tutee by providing the tutee’s name
+2. TC confirms that the process is done.
++
+Use case ends.
+
+*Extensions*
+[none]
+* 1a. The name does not exist in address book
++
+[none]
+** 1a1. TC requests user to retype the tutee’s name.
+** 1a2. User types in the name.
+** Steps 1a1.- 1a2. are repeated until a valid name is provided.
+** Use case resumes from Step 2.
+
+* *a. At any time, user can cancel the request.
+[none]
+** *a1 TC requests confirmation of the cancelation.
+** *a2. User confirms the cancellation.
+** Use case ends.
+
+* 2a. The name is already inside the tutee list.
++
+[none]
+** 2a1. TC indicates that the name is already inside the tutee list.
+** 2a2.  User confirms the message.
+** Use case ends.
+
+=== Use case: UC05 - Viewing schedule within a date range
+*MSS*
+
+1. User requests to view schedule.
+2. TC requests a date range.
+3. User provides the desired date range.
+4. TC lists all schedule within the date range.
+5. User chooses to close the list.
++
+Use Case ends.
+
+*Extensions*
+
+[none]
+* 3a. Invalid date range format is given.
++
+[none]
+** 3a1. TC requests a valid date range input.
+** 3a2. User provides the date range.
+** Use case resumes from step 4.
+
+* *a. At any time, user can cancel adding the schedule.
+[none]
+** *a1 TC requests confirmation of the cancelation.
+** *a2. User confirms the cancellation.
+** Use case ends.
+
+
+* 4a. No schedule is created within the date range.
+[none]
+**	4a1. TC reports that no schedule exists within the time range.
+**	4a2. User acknowledges.
+**	Use case ends.
+
 _{More to be added}_
 
 [appendix]
@@ -852,6 +1033,16 @@ _{More to be added}_
 .  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 1000 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.
+.  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 1000 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.
+.  Users should prefer typing over mouse input or other input methods.
+.  Users should be comfortable using CLI apps.
+.  The app should not have flow flaws when running.
+.  The app may utilise third party libraries, API and plug-ins.
+.  The app should be able to access the Internet.
+.  The app should be able to perform basic commands without internet access.
+
 
 _{More to be added}_