Skip to content

Commit 63233be

Browse files
committed
Improve UG and DG based on feedback
1 parent 3ded61e commit 63233be

29 files changed

Lines changed: 167 additions & 48 deletions

docs/DeveloperGuide.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ title: Developer Guide
66
{:toc}
77

88
--------------------------------------------------------------------------------------------------------------------
9+
## **Introduction**
910

11+
fitNUS is tailored for **NUS students** that are interested in staying healthy and keeping fit. It is suitable for **all
12+
fitness levels** and is equipped with a **customisable timetable** for you to manage your time wisely and slot in your
13+
workout routines with ease.
14+
15+
This developer guide is for users who are interested in our design philosophy and for future developers of fitNUS.
16+
17+
--------------------------------------------------------------------------------------------------------------------
1018
## **Setting up, getting started**
1119

1220
Refer to the guide [_Setting up and getting started_](SettingUp.md).
@@ -15,7 +23,7 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).
1523

1624
## **Design**
1725

18-
### Architecture (Jing Qian)
26+
### Architecture
1927

2028
<img src="images/ArchitectureDiagram.png" width="450" />
2129

@@ -57,7 +65,7 @@ The *Sequence Diagram* below shows how the components interact with each other f
5765

5866
The sections below give more details of each component.
5967

60-
### UI component (Jing Qian)
68+
### UI component
6169

6270
![Structure of the UI Component](images/UiClassDiagram.png)
6371

@@ -73,7 +81,7 @@ The `UI` component,
7381
* Executes user commands using the `Logic` component.
7482
* Listens for changes to `Model` data so that the UI can be updated with the modified data.
7583

76-
### Logic component (Jing Qian)
84+
### Logic component
7785

7886
![Structure of the Logic Component](images/LogicClassDiagram.png)
7987

@@ -93,7 +101,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
93101
<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `ExerciseDeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
94102
</div>
95103

96-
### Model component (Jing Qian)
104+
### Model component
97105

98106
![Structure of the Model Component](images/ModelClassDiagram.png)
99107

@@ -114,7 +122,7 @@ The `Model`,
114122
</div>
115123

116124

117-
### Storage component (Jing Qian)
125+
### Storage component
118126

119127
![Structure of the Storage Component](images/StorageClassDiagram.png)
120128

@@ -134,7 +142,7 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
134142

135143
This section describes some noteworthy details on how certain features are implemented.
136144

137-
### Create routine (Jing Qian)
145+
### Create routine
138146

139147
The feature to create a routine in fitNUS is implemented using `RoutineCreateCommand` class, which inherits from
140148
`Command` class. The argument is supplied after parsing the user input by the `RoutineCreateCommandParser` class.
@@ -174,7 +182,7 @@ Given below is the sequence diagram showing how the routine creation command is
174182

175183
![Routine Create](./images/RoutineAddSequenceDiagram.png)
176184

177-
### Add Routine to Timetable (Nicholas)
185+
### Add Routine to Timetable
178186

179187
The `TimetableAddRoutineCommandParser` and `TimetableAddRoutineCommand` classes parse and execute the user input
180188
to add a routine to the timetable in fitNUS.
@@ -221,7 +229,7 @@ execute("timetable_add_routine r/Leg Workout d/Monday T/1600-1700") API call.
221229

222230
![TimetableAddRoutineSequenceDiagram](images/TimetableAddRoutineSequenceDiagram.png)
223231

224-
### Find exercises (Licheng)
232+
### Find exercises
225233

226234
The find exercises feature is implemented using `FindExercisesCommandParser`, as well as the following command:
227235
* `FindExercisesCommand`, to be executed when the user inputs the command into fitNUS.
@@ -268,7 +276,7 @@ API call.
268276

269277
![FindExercisesSequenceDiagram](images/FindExercisesSequenceDiagram.png)
270278

271-
### Delete lesson (Iqbal)
279+
### Delete lesson
272280

273281
The delete lesson feature is implemented using `LessonDeleteCommandParser`, as well as the following command:
274282
* `LessonDeleteCommand`, to be executed when the user inputs the command into fitNUS.
@@ -339,7 +347,7 @@ The GUI then lists the deleted lesson.
339347
around their classes.
340348

341349

342-
### User stories (Jing QIan)
350+
### User stories
343351

344352
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
345353

@@ -352,7 +360,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
352360
| `* * *` | health-conscious individual | log my BMI | keep better track of my health.
353361

354362

355-
### Use cases (Licheng)
363+
### Use cases
356364

357365
(For all use cases below, the **System** is the `fitNUS` and the **Actor** is the `user`, unless specified otherwise)
358366

@@ -597,7 +605,7 @@ testers are expected to do more *exploratory* testing.
597605

598606
1. _{ more test cases …​ }_
599607

600-
### Deleting a Routine (Jing Qian)
608+
### Deleting a Routine
601609

602610
1. Deleting a Routine
603611

0 commit comments

Comments
 (0)