[CS2113-W12-4] Fit Track #13
Conversation
…endar Jingxi-Calendar
docs/DeveloperGuide.md
Outdated
|
|
||
| <div markdown="span" class="alert alert-primary"> | ||
|
|
||
| :bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams) |
There was a problem hiding this comment.
The :bulb is not showing up correctly
docs/DeveloperGuide.md
Outdated
| * [**`WorkoutList`**](#workout-list-component): Stores all workouts. | ||
| * [**`Parser`**](#parser-component): Handles user input. | ||
| * [**`Data`**](#data-component): Holds the data of the app in memory. | ||
| * [**`Command`**](#command-component): The command executor. |
docs/DeveloperGuide.md
Outdated
| ### Core sequence | ||
| Core sequence of code is written in [`FitTrack`](../src/main/java/fittrack/FitTrack.java) class. | ||
|
|
||
|  |
There was a problem hiding this comment.
Possible to remove the bottom object names with hide footbox
docs/DeveloperGuide.md
Outdated
|
|
||
|  | ||
|
|
||
|  |
There was a problem hiding this comment.
For Core Structure, is "do-while" supposed to be "loop" instead?
|  | ||
| The sequence diagram of the code for loading the file contents into each class. | ||
|
|
||
|  |
There was a problem hiding this comment.
For Main Structure of Storage Save, the :FIleWriter on the right is hard to read, maybe choose a different colour?
docs/DeveloperGuide.md
Outdated
| |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list| | ||
| |Version| As a ... | I want to ... | So that I can ... | | ||
| |--------|----------|-------------------------------------------------------------|---------------------------------------------------------------| | ||
| |v1.0|new user| know how to use the product | use the product | |
There was a problem hiding this comment.
Make the user comments more specific for the things that you want to implement. For example, a user knowing how to run your application doesn't really say much about what needs to be changed or updated
docs/DeveloperGuide.md
Outdated
|
|
||
|
|
||
| ### Architecture | ||
| {insert diagram to show architecture of code} |
There was a problem hiding this comment.
Im not sure if I just missed it or its a work in progress but I didn't see the diagram in the initial DG
|
|
||
| ### Value proposition | ||
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
| Fittrack is a health management application which allows users to record their diet and activity, and help them to reach the goal they have set. |
There was a problem hiding this comment.
This is a really good value proposition, straight to the point
docs/DeveloperGuide.md
Outdated
| |v2.0|user| see the total calories I have burnt on a particular date | track my daily calories burnt | | ||
| |v2.0|user| find a meal or workout | quickly search my past meals or workouts | | ||
|
|
||
|
|
||
|
|
||
| ## Non-Functional Requirements | ||
|
|
||
| {Give non-functional requirements} |
There was a problem hiding this comment.
Is this supposed to be a diagram or are there no non-functional requirements?
|
|
||
| main -> main ++: loopCommandExecution() | ||
|
|
||
| group do-while [!ExitCommand.isExit(command)] |
There was a problem hiding this comment.
Is this representation of loop also acceptable? In our textbook the usual representation is "loop"
docs/DeveloperGuide.md
Outdated
|
|
||
| <div markdown="span" class="alert alert-primary"> | ||
|
|
||
| :bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams) |
There was a problem hiding this comment.
The link to diagrams folder is not working
| main -> ui ++: ui.printCR(commandResult: CR) | ||
| note left: Print the result of execution | ||
| note right: CR for CommandResult | ||
| return |
There was a problem hiding this comment.
The sequence diagram is generally clear and easy to read!
| participant ":WorkoutListDecoder" as wDecoder STORAGE_COLOR_T3 | ||
|
|
||
| main -> main ++: start() | ||
| activate main MODEL_COLOR |
There was a problem hiding this comment.
I like the colored representation. It allows readers to differentiate each class more easily.
docs/images/FitTrackCore.svg
Outdated
There was a problem hiding this comment.
Perhaps the footer box can be removed.
docs/images/FitTrackCore.svg
Outdated
There was a problem hiding this comment.
Perhaps the word 'loop' can be used instead.
docs/images/StorageSave.svg
Outdated
There was a problem hiding this comment.
Perhaps this could be 'elements in mealArr' instead.
Modify codes and UG
Fix profile loading bug
Add sequence diagrams
Resolves #60
Update UG
Update DG
Update DG PPP
Update AboutUs.md
# Conflicts: # docs/DeveloperGuide.md
Update DG Final
Update PPP
Update PPP for Nixon
FitTrack allows users to track meals and workouts, helping them to adjust their diet and exercise to lead a healthy lifestyle. It is optimised for CLI users so that tracking can be done efficiently and easily by typing in commands.