Merge pull request nus-cs2103-AY2021S1#85 from khor-jingqian/improve-dg-ug

Improve DG and UG

Author: Licheng-Wu

docs/DeveloperGuide.md

@@ -147,12 +147,12 @@ Format: `routine_view INDEX`
 Examples:
 * `routine_view 2` Views routine with the index 2.
 
-##### Before input:
+**Before input:**
 
 ![Routine View](./images/routine_view.png)
 
 
-#### After input:
+**After input:**
 
 ![Routine View After](./images/routine_view_after.png)
 
@@ -173,10 +173,11 @@ Format: `find_routines KEYWORD`
 Example:
 * `find_routines upper` Finds all routines with the keyword "upper" in its name, regardless of uppercase or lowercase.
 
-##### Input:
+**Input:**
+
 ![Find Routines](./images/routine_find.png)
 
-##### Result:
+**Result:**
 
 ![Find Routines Result](./images/routine_find_after.png)
 
@@ -201,9 +202,15 @@ Deletes an existing lesson in fitNUS corresponding to the given index.
 Format: `lesson_delete INDEX`
 
 Example:
-* `lesson_delete 1` Deletes the lesson at index 1 in the list.
+* `lesson_delete 2` Deletes the lesson at index 2 in the list.
+
+**Before**
+
+![Lesson Delete Before](./images/lesson_delete_before.png)
 
-![Lesson Delete](./images/lesson_delete.png)
+**After**
+
+![Lesson Delete After](./images/lesson_delete_after.png)
 
 #### 3.3.3 List lessons : `list_lessons`
 
@@ -345,7 +352,8 @@ Action | Format |
 **Link to User Guide** | `help` 
 **Save and exit fitNUS** | `exit`
 
-### 4.2 Exercise 
+### 4.2 Exercise
+
 Action | Format | Examples
 --------|-------|-----------
 **Create Exercise** | `exercise_add n/EXERCISE_NAME [t/TAG]` | `exercise_add n/Bench Press t/Upper`
@@ -354,6 +362,7 @@ Action | Format | Examples
 **List Exercises** | `list_exercises`
 
 ### 4.3 Routine 
+
 Action | Format | Examples
 --------|-------|-----------
 **Create Routine** | `routine_create r/ROUTINE_NAME` | `routine_create r/Leg Day Session`
@@ -364,6 +373,7 @@ Action | Format | Examples
 **List Routines** | `routine list`
 
 ### 4.4 Lesson
+
 Action | Format | Examples
 --------|-------|-----------
 **Create Lesson** | `lesson_add n/EXERCISE_NAME [t/TAG]` | `lesson_add n/CS2100 t/Thursday t/0900 t/1hours`
@@ -372,6 +382,7 @@ Action | Format | Examples
 **Find Lessons** | `find_lessons KEYWORD [MORE_KEYWORDS]` | `find_lessons CS2103T`
 
 ### 4.5 Timetable
+
 Action | Format | Examples
 --------|-------|-----------
 **Add Routine to Timetable** | `timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK T/TIMING` | `timetable_add_routine add r/Leg Day Session d/Monday T/1600-1800`
@@ -380,6 +391,7 @@ Action | Format | Examples
 **View timetable** | `timetable view`
 
 ### 4.6 BMI
+
 Action | Format | Examples
 --------|-------|-----------
 **Add or edit Height** | `height h/HEIGHT` | `height h/170`

docs/UserGuide.md

@@ -7,19 +7,19 @@ Participant ":Logic" as logic LOGIC_COLOR
 Participant ":Model" as model MODEL_COLOR
 Participant ":Storage" as storage STORAGE_COLOR
 
-user -[USER_COLOR]> ui : "delete 1"
+user -[USER_COLOR]> ui : "exercise_add n/Bicep"
 activate ui UI_COLOR
 
-ui -[UI_COLOR]> logic : execute("delete 1")
+ui -[UI_COLOR]> logic : execute("exercise_add n/Bicep")
 activate logic LOGIC_COLOR
 
-logic -[LOGIC_COLOR]> model : deletePerson(p)
+logic -[LOGIC_COLOR]> model : addExercise(e)
 activate model MODEL_COLOR
 
 model -[MODEL_COLOR]-> logic
 deactivate model
 
-logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook)
+logic -[LOGIC_COLOR]> storage : saveFitNus(fitnus)
 activate storage STORAGE_COLOR
 
 storage -[STORAGE_COLOR]> storage : Save to file

docs/diagrams/ArchitectureSequenceDiagram.puml

@@ -3,66 +3,70 @@
 
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
-participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
-participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR
-participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR
+participant ":FitNusParser" as FitNusParser LOGIC_COLOR
+participant ":ExerciseDeleteCommandParser" as ExerciseDeleteCommandParser LOGIC_COLOR
+participant "d:ExerciseDeleteCommand" as ExerciseDeleteCommand LOGIC_COLOR
 participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 end box
 
-[-> LogicManager : execute("delete 1")
+[-> LogicManager : execute("exercise_delete 1")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand("delete 1")
-activate AddressBookParser
+LogicManager -> FitNusParser : parseCommand("exercise_delete 1")
+activate FitNusParser
 
-create DeleteCommandParser
-AddressBookParser -> DeleteCommandParser
-activate DeleteCommandParser
+create ExerciseDeleteCommandParser
+FitNusParser -> ExerciseDeleteCommandParser
+activate ExerciseDeleteCommandParser
 
-DeleteCommandParser --> AddressBookParser
-deactivate DeleteCommandParser
+ExerciseDeleteCommandParser --> FitNusParser
+deactivate ExerciseDeleteCommandParser
 
-AddressBookParser -> DeleteCommandParser : parse("1")
-activate DeleteCommandParser
+FitNusParser -> ExerciseDeleteCommandParser : parse("1")
+activate ExerciseDeleteCommandParser
 
-create DeleteCommand
-DeleteCommandParser -> DeleteCommand
-activate DeleteCommand
+create ExerciseDeleteCommand
+ExerciseDeleteCommandParser -> ExerciseDeleteCommand
+activate ExerciseDeleteCommand
 
-DeleteCommand --> DeleteCommandParser : d
-deactivate DeleteCommand
+ExerciseDeleteCommand --> ExerciseDeleteCommandParser : d
+deactivate ExerciseDeleteCommand
 
-DeleteCommandParser --> AddressBookParser : d
-deactivate DeleteCommandParser
+ExerciseDeleteCommandParser --> FitNusParser : d
+deactivate ExerciseDeleteCommandParser
 'Hidden arrow to position the destroy marker below the end of the activation bar.
-DeleteCommandParser -[hidden]-> AddressBookParser
-destroy DeleteCommandParser
+ExerciseDeleteCommandParser -[hidden]-> FitNusParser
+destroy ExerciseDeleteCommandParser
 
-AddressBookParser --> LogicManager : d
-deactivate AddressBookParser
+FitNusParser --> LogicManager : d
+deactivate FitNusParser
 
-LogicManager -> DeleteCommand : execute()
-activate DeleteCommand
+LogicManager -> ExerciseDeleteCommand : execute()
+activate ExerciseDeleteCommand
 
-DeleteCommand -> Model : deletePerson(1)
+ExerciseDeleteCommand -> Model : getFilteredExerciseList()
 activate Model
 
-Model --> DeleteCommand
+Model --> ExerciseDeleteCommand
+
+ExerciseDeleteCommand -> Model : exerciseDelete(index)
+
+Model --> ExerciseDeleteCommand
 deactivate Model
 
 create CommandResult
-DeleteCommand -> CommandResult
+ExerciseDeleteCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> DeleteCommand
+CommandResult --> ExerciseDeleteCommand
 deactivate CommandResult
 
-DeleteCommand --> LogicManager : result
-deactivate DeleteCommand
+ExerciseDeleteCommand --> LogicManager : result
+deactivate ExerciseDeleteCommand
 
 [<--LogicManager
 deactivate LogicManager

docs/diagrams/DeleteSequenceDiagram.puml

@@ -3,7 +3,7 @@
 
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
-participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":FitNusParser" as FitNusParser LOGIC_COLOR
 participant ":FindExercisesCommandParser" as FindExercisesCommandParser LOGIC_COLOR
 participant "f:FindExercisesCommand" as FindExercisesCommand LOGIC_COLOR
 participant ":CommandResult" as CommandResult LOGIC_COLOR
@@ -16,17 +16,17 @@ end box
 [-> LogicManager : execute("find_exercises bench")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand("find_exercises bench")
-activate AddressBookParser
+LogicManager -> FitNusParser : parseCommand("find_exercises bench")
+activate FitNusParser
 
 create FindExercisesCommandParser
-AddressBookParser -> FindExercisesCommandParser
+FitNusParser -> FindExercisesCommandParser
 activate FindExercisesCommandParser
 
-FindExercisesCommandParser --> AddressBookParser
+FindExercisesCommandParser --> FitNusParser
 deactivate FindExercisesCommandParser
 
-AddressBookParser -> FindExercisesCommandParser : parse("bench")
+FitNusParser -> FindExercisesCommandParser : parse("bench")
 activate FindExercisesCommandParser
 
 create FindExercisesCommand
@@ -36,14 +36,14 @@ activate FindExercisesCommand
 FindExercisesCommand --> FindExercisesCommandParser : f
 deactivate FindExercisesCommand
 
-FindExercisesCommandParser --> AddressBookParser : f
+FindExercisesCommandParser --> FitNusParser : f
 deactivate FindExercisesCommandParser
 'Hidden arrow to position the destroy marker below the end of the activation bar.
-FindExercisesCommandParser -[hidden]-> AddressBookParser
+FindExercisesCommandParser -[hidden]-> FitNusParser
 destroy FindExercisesCommandParser
 
-AddressBookParser --> LogicManager : f
-deactivate AddressBookParser
+FitNusParser --> LogicManager : f
+deactivate FitNusParser
 
 LogicManager -> FindExercisesCommand : execute()
 activate FindExercisesCommand

docs/diagrams/FindExercisesSequenceDiagram.puml

@@ -8,7 +8,7 @@ package Logic {
 
 package Parser {
 Interface Parser <<Interface>>
-Class AddressBookParser
+Class FitNusParser
 Class XYZCommandParser
 Class CliSyntax
 Class ParserUtil
@@ -35,8 +35,8 @@ Class HiddenOutside #FFFFFF
 HiddenOutside ..> Logic
 
 LogicManager .up.|> Logic
-LogicManager -->"1" AddressBookParser
-AddressBookParser .left.> XYZCommandParser: creates >
+LogicManager -->"1" FitNusParser
+FitNusParser .left.> XYZCommandParser: creates >
 
 XYZCommandParser ..> XYZCommand : creates >
 XYZCommandParser ..|> Parser
@@ -53,7 +53,7 @@ LogicManager .left.> Command : executes >
 
 LogicManager --> Model
 Command .right.> Model
-note right of XYZCommand: XYZCommand = AddCommand, \nFindCommand, etc
+note right of XYZCommand: XYZCommand = ExerciseAddCommand, \nFindExercisesCommand, etc
 
 Logic ..> CommandResult
 LogicManager .down.> CommandResult

docs/diagrams/LogicClassDiagram.puml

@@ -5,23 +5,32 @@ skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
 
 Package Model <<Rectangle>>{
-Interface ReadOnlyAddressBook <<Interface>>
+Interface ReadOnlyFitNus <<Interface>>
 Interface Model <<Interface>>
 Interface ObservableList <<Interface>>
-Class AddressBook
-Class ReadOnlyAddressBook
+Class FitNus
+Class ReadOnlyFitNus
 Class Model
 Class ModelManager
 Class UserPrefs
 Class ReadOnlyUserPrefs
 
-Package Person {
-Class Person
-Class Address
-Class Email
+Package Exercise {
+Class Exercise
 Class Name
-Class Phone
-Class UniquePersonList
+Class UniqueExerciseList
+}
+
+Package Routine {
+Class Routine
+Class Name
+Class UniqueRoutineList
+}
+
+Package Lesson {
+Class Lesson
+Class Name
+Class UniqueLessonList
 }
 
 Package Tag {
@@ -32,25 +41,23 @@ Class Tag
 Class HiddenOutside #FFFFFF
 HiddenOutside ..> Model
 
-AddressBook .up.|> ReadOnlyAddressBook
+FitNus .up.|> ReadOnlyFitNus
 
 ModelManager .up.|> Model
 Model .right.> ObservableList
-ModelManager o--> "1" AddressBook
+ModelManager o--> "1" FitNus
 ModelManager o-left-> "1" UserPrefs
 UserPrefs .up.|> ReadOnlyUserPrefs
 
-AddressBook *--> "1" UniquePersonList
-UniquePersonList o--> "*" Person
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
-Person *--> "*" Tag
+FitNus *--> "1" UniqueExerciseList
+FitNus *--> "1" UniqueLessonList
+UniqueExerciseList o--> "*" Exercise
+Exercise *--> Name
+Exercise *--> "*" Tag
 
-Name -[hidden]right-> Phone
-Phone -[hidden]right-> Address
-Address -[hidden]right-> Email
 
-ModelManager -->"1" Person : filtered list
+FitNus *--> "1" UniqueRoutineList
+UniqueRoutineList o--> "*" Routine
+Routine --> "*" Exercise
+ModelManager -->"1" Exercise : filtered list
 @enduml