[W9][T08-2] Jerome Tan : Update of documents

docs/AboutUs.adoc

@@ -4,53 +4,43 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+StudentHandBook was developed by https://github.com/cs2113-ay1819s2-t08-2/main[StudentHandBook] team. +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== TAN WEI SHENG, JEROME
+image::jerome.png[width="150", align="left"]
+{empty}[https://github.com/jayrometan[github]]
 
-Role: Project Advisor
+Role: Team Leader, Developer +
+Responsibilities: Developer Guide, Implementing Task Feature
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
-Responsibilities: UI
-
-'''
-
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== WONG YU QI
+image::yuqi.png[width="150", align="left"]
+{empty}[https://github.com/wongyuqi[github]]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: User Guide, Implementing Timer Feature
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== PANG YONG JIA
+image::yongjia.png[width="150", align="left"]
+{empty}[https://github.com/yongjia96[github]]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Use Cases, Workout Feature
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== LAUW WEI ZHONG
+image::weizhong.png[width="150", align="left"]
+{empty}[https://github.com/weizhonglauw[github]]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Admin Information, Expenditure Tracker Feature
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at `e0200817 [at] comp.nus.edu.sg`

docs/DeveloperGuide.adoc

@@ -866,56 +866,214 @@ See this https://github.com/se-edu/addressbook-level4/pull/599[PR] for the step-
 
 Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*`
 
-[width="59%",cols="22%,<23%,<25%,<30%",options="header",]
-|=======================================================================
+
+Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*`
+
+[width="100%",cols="22%,<23%,<25%,<30%",options="header",]
+|===========================================================================================================================================
 |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 |see usage instructions |refer to instructions when I forget how to use the App
+|`* * *` |user |create a list of daily tasks |form a habit
+|`* * *` |user |tick off entries from the list of daily tasks |remove entries that I have accomplished
+|`* * *` |user |view the list of daily tasks |remember what else I should accomplish
+|`* * *` |user |clear the list of daily tasks |remove the all the tasks if I had accomplished them all
+|`* * *` |user |add a new purchase I had spent on |keep a record of my expenditure
+|`* * *` |user |delete a purchase made |remove items I had keyed n wrongly
+|`* * *` |user |view list of expenses made |check on what i have spent on
+|`* * *` |user |clear list of expenses made |have a new record of my expenditure
+|`* * *` |user |find a purchase made |check back on the amount I had spent on a particular purchase
+|`* * *` |user |view my previous workout logs |keep track of my workout history
+|`* * *` |user |record a completed workout |refer back to it
+|`* * *` |user |have a timer |keep track of the duration at which i spend doing certain activities
+|===========================================================================================================================================
 
-|`* * *` |user |add a new person |
+[appendix]
+
+[appendix]
+== Use Cases
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+(For all use cases below, the *System* is the `StudentHandBook` and the *Actor* is the `user`, unless specified otherwise)
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+=== Use case: Add a  task
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+*MSS*
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
-|=======================================================================
+. User requests to add a new task  +
+example: `addTask n/Update CS2113T Developer Guide
+ d/311219 h/2359` +
+. StudentHandBook adds the task into the array list +
+Use case ends.
 
-_{More to be added}_
 
-[appendix]
-== Use Cases
+=== Use case: Edit a task
 
-(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
+*MSS*
 
-[discrete]
-=== Use case: Delete person
+. StudentHandBook already shows a list of daily tasks
+. User requests to edit a specific task in the list via INDEX
+e.g. `editTask INDEX n/REDO CS2113T`
+. StudentHandBook edits the task
++
+Use case ends.
+
+*Extensions*
+
+* 2a. Task List is empty.
++
+Use case ends.
+
+* 3a. Index not in Task List.
+** 3a1. StudentHandBook shows an error message.
++
+Use case ends.
+
+== Use Case: Delete a Task
+
+*MSS*
+
+. StudentHandBook already displays the task list
+. User requests to remove the task with `deleteTask INDEX`
+. StudentHandBook removes the task
++
+Use case ends.
+
+*Extensions*
+
+* 1. Task List is empty.
++
+Use case ends.
+* 2a. Index not in Task List.
+** 2a1. StudentHandBook shows an error message.
++
+Use case ends.
+
+
+
+== Use Case: Add a new purchase
+
+*MSS*
+
+. User requests to add a new purchase into the Expenditure List
+. StudentHandBook adds the purchase into the Expenditure List with name of purchase and its price
++
+Use case ends.
+
+== Use Case: View Expenditure List
 
 *MSS*
 
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+. User requests to list expenditure
+. StudentHandBook shows the Expenditure List
 +
 Use case ends.
 
 *Extensions*
 
-[none]
-* 2a. The list is empty.
+* 1a. Expenditure List is empty.
 +
 Use case ends.
 
-* 3a. The given index is invalid.
+== Use Case: Delete a purchase
+
+*MSS*
+
+. User requests to view Expenditure List
+. StudentHandBook shows the Expenditure List
+. User requests to delete a specific purchase on the list
+. StudentHandBook deletes the purchase
 +
-[none]
-** 3a1. AddressBook shows an error message.
+Use case ends.
+
+*Extensions*
+
+* 2a. Daily List is empty.
 +
-Use case resumes at step 2.
+Use case ends.
 
-_{More to be added}_
+* 3a. Index not in Daily List.
+** 3a1. StudentHandBook shows an error message.
++
+Use case ends.
+
+
+== Use Case: Clear Expenditure List
+
+*MSS*
+
+. User requests to view Expenditure List
+. StudentHandBook shows the Expenditure List
+. User requests to clear the Expenditure List
++
+Use case ends.
+
+== Use Case: Find a specific purchase
+
+*MSS*
+
+. User requests to see log of a specific purchase
+. StudentHandBook shows this particular purchase with its price
++
+Use case ends.
+
+*Extensions*
+
+* 1a. Expenditure List is empty.
++
+Use case ends.
+
+* 2a. Index not in Daily List.
+** 2a1. StudentHandBook shows an error message.
++
+Use case ends.
+
+== Use Case: Start Stopwatch
+
+*MSS*
+
+. User requests to start a stopwatch
+. StudentHandBook records the time
++
+Use case ends.
+
+== Use Case: Stop Stopwatch
+
+*MSS*
+
+. User requests to stop the running stopwatch
+. StudentHandBook retrieves the start time and shows the total time elapsed
++
+Use case ends.
+
+*Extensions*
+
+* 1a. User did not start the stopwatch.
+** 1a1. StudentHandBook shows an error message.
++
+Use case ends.
+
+== Use Case: Record Completed Workout
+
+*MSS*
+
+. User requests to add an entry of completed workout
+. StudentHandBook records the workout log
++
+Use case ends.
+
+== Use Case: View Workout Log
+
+*MSS*
+
+. User requests to view Workout Log
+. StudentHandBook shows the Workout Log
++
+Use case ends.
+
+*Extensions*
+
+* 1a. Workout Log is empty.
++
+Use case ends.
 
 [appendix]
 == Non Functional Requirements