[CS2113T-T09-1] Control Your Crowd #13
Conversation
docs/DeveloperGuide.md
Outdated
|
|
||
| Classes used by multiple components are in the `seedu.Duke.commons` package. | ||
|
|
||
| ## Implementation |
There was a problem hiding this comment.
Perhaps there can be an implementation component to help developers understand how Safest Entry Tracker is implemented?
| * a `Phone` object | ||
|
|
||
| ### Storage component | ||
| **API** : [`seedu.duke.storage`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/storage) package |
iamakilahamed
changed the title
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Product scope | ||
| ### Target user profile | ||
| ### Architecture |
There was a problem hiding this comment.
It's good to contain the architecture section. Maybe it can be better to provide a diagram to show the overall architecture. ( Refer to the AB3 DG example)
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Common classes | ||
|
|
||
| Classes used by multiple components are in the `seedu.Duke.commons` package. |
There was a problem hiding this comment.
It's decent to have common classes to be used by multiple components. What's in this class? Are constants and messages or something else? Perhaps it would be better to give more details. :)
docs/DeveloperGuide.md
Outdated
| **API** : [`seedu.duke.person`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/person) package | ||
|
|
||
|
|
||
| <img src="images/ModelComponentStructure.png" width="600" height="600" /> |
docs/DeveloperGuide.md
Outdated
|
|
||
| Classes used by multiple components are in the `seedu.Duke.commons` package. | ||
|
|
||
| ## Implementation |
There was a problem hiding this comment.
The implementation is quite important in DG. Perhaps your team hasn't started yet, it would be better to show every important feature here with the help of literal explanation and sequence diagrams! Looking forward to your results.
| The `UI` component, | ||
|
|
||
| * Reads user commands using `Scanner` class. | ||
| * Pass raw user commands into `Parser` class under **Logic Component**. |
There was a problem hiding this comment.
You can perhaps use "passes" here for standardization purposes :)
|
|
||
| Given below is the Sequence Diagram for interactions within the `Logic` component for the `parseCommand("clear)"` API call. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is the "calling arrow" correct in illustraing the interactions between :ClearParser and :ClearCommand?
|
|
||
| Given below is the Sequence Diagram for interactions within the `Logic` component for the `parseCommand("clear)"` API call. | ||
|
|
||
|  |
|
|
||
| ### Logic component | ||
|
|
||
|  |
There was a problem hiding this comment.
A well designed diagram with correct notations!
For, "XYZParser = CheckInParser, FindParser, etc" it could look like assignment here. Perhaps you can make it free from any ambiguity :)
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Model component | ||
|
|
||
| **API** : [`seedu.duke.person`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/person) package |
There was a problem hiding this comment.
I like this diagram, it is both comprehensible and well integrated into the description!
| * Reads user commands using `Scanner` class. | ||
| * Pass raw user commands into `Parser` class under **Logic Component**. | ||
| * After the **Logic Component** has executed the function, it will then return `CommandOutput` object | ||
| which contains the outcome of the execution, fail or succeed. |
docs/DeveloperGuide.md
Outdated
|
|
||
|
|
||
| ### Storage component | ||
| **API** : [`seedu.duke.storage`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/storage) package |
|
|
||
| ### Storage component | ||
| **API** : [`seedu.duke.storage`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/storage) package | ||
|  |
There was a problem hiding this comment.
This diagram is also great and the only one advice which could be given is regarding the size of this diagram. You could consider resizing it so that the text size in the diagram matches that of the main text. :)
| 5. The result of the command execution is encapsulated as a `CommandOutput` object which is passed back to the `TextUi`. | ||
| 6. In addition, the `CommandOutput` object can also instruct the `TextUi` to perform certain actions, such as displaying the list to the user. |
There was a problem hiding this comment.
Not clearly shown in the logic diagram, shouldn't the arrow point to the UI class since the CommandOutput calls the TextUi?
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Product scope | ||
| ### Target user profile | ||
| ### Architecture |
There was a problem hiding this comment.
An overall diagram that shows how each major component interacts with one another would be useful
| The Model component, | ||
|
|
||
| * contains a `Person` class which represents a person who checks in/out. | ||
| * contains a `TrackingList` class which uses an ArrayList to keep track of all the `Person` objects who have currently checked in/out. | ||
| * contains a `PersonLog` class which uses a HashMap to permanently store all the `Person` objects who have checked in before. | ||
|
|
||
| A `Person` object contains: | ||
| * an `Id` object | ||
| * a `Name` object | ||
| * a `Phone` object |
docs/DeveloperGuide.md
Outdated
| |Version| As a ... | I want to ... | So that I can ...| | ||
| |Priority| As a ... | I want to ... | So that I can ...| | ||
| |--------|----------|---------------|------------------| | ||
| |v1.0|new user|see usage instructions|refer to them when I forget how to use the application| | ||
| |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list| | ||
| |*****|mall staff|be able to review the personal particulars of the customer|be aware of who he is| | ||
| |*****|new user|be able to use the program without much training| use the program as soon as possible and easily implement it| | ||
| |****|mall staff|key in personal particulars easily into the application| check in visitors quickly without holding up a line of customers| | ||
| |****|mall staff|be able to easily key in a unique personal identifier| check in and find a visitor| |
There was a problem hiding this comment.
I like how priorities are added to the user stories to show the importance. But it seems like more user stories can be added
docs/DeveloperGuide.md
Outdated
|
|
||
|
|
||
| ### Storage component | ||
| **API** : [`seedu.duke.storage`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/storage) package |
There was a problem hiding this comment.
Inconsistent formatting, Tracking List Encoder should be written as TrackingListEncoder
|
|
||
| The `Storage` component, | ||
| * saves and encodes `Person` objects in `Tracking List` into a `.txt` file. | ||
| * reads a `.txt` file of valid encoding and populates a `TrackingList` |
There was a problem hiding this comment.
Consider defining the term "valid encoding"
docs/DeveloperGuide.md
Outdated
| |*****|mall staff|be able to review the personal particulars of the customer|be aware of who he is| | ||
| |*****|new user|be able to use the program without much training| use the program as soon as possible and easily implement it| | ||
| |****|mall staff|key in personal particulars easily into the application| check in visitors quickly without holding up a line of customers| | ||
| |****|mall staff|be able to easily key in a unique personal identifier| check in and find a visitor| |
There was a problem hiding this comment.
Consider adding a legend section that explains the use of the asterisks
docs/DeveloperGuide.md
Outdated
|
|
||
| <img src="images/ModelComponentStructure.png" width="600" height="600" /> | ||
|
|
||
| *Figure #. Structure of the Model Component* |
|
|
||
| ### Logic component | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider standardizing size of diagrams
docs/DeveloperGuide.md
Outdated
| **API** : [`seedu.duke.person`](https://github.com/AY2021S2-CS2113T-T09-1/tp/tree/master/src/main/java/seedu/duke/person) package | ||
|
|
||
|
|
||
| <img src="images/ModelComponentStructure.png" width="600" height="600" /> |
There was a problem hiding this comment.
Comprehensive and detailed diagram
| `TrackingListEncoder` takes the currently stored `TrackingList` and converts it to a more storage friendly String. | ||
| This String is then written to a file on the disk, known on the diagram as `StoredTrackingList`. | ||
| As the name suggests, `TrackingListDecoder` achieves the reverse by taking the file on drive, `StoredTrackingList`, | ||
| and interprets the file to be loaded into the memory as a `TrackingList`. |
There was a problem hiding this comment.
Overall I think the others have already done a good job reviewing your guys DG. I really like the diagrams that you used; I think they are very clear and easy to understand. You could consider adding an overall architecture section explaining how you've split up the components before diving in.
|
|
||
|  |
There was a problem hiding this comment.
I really like the use of the notes to make it clear what XYZCommand and XYZParser is referring to
Change editmax command error message and removed name for location
fix general input error
Check if a visitor has already checked in
…eckedin people. Need to edit editmax command to handle exception and location test needs to be changed.
PED fixes
fix check in ui
Non-code updates
Updated PPP again
Update to PPP
fix help message error
update Dev Ops
Update ppp
update PPP
updated my pppppp
Fix Dev Ops Header
Update PPP
Fix PR links
Safest Entry Tracker (SET) is a desktop app to track and access customer personal details and their profiles during pandemics via a Command Line Interface (CLI).