-
Notifications
You must be signed in to change notification settings - Fork 262
[CS2103T-W12-4] CookBuddy #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
[CS2103T-W12-4] CookBuddy #36
Conversation
docs/DeveloperGuide.adoc
Outdated
| | Priority | Difficulty | As a… | I can… | So that… | ||
| | 1 | 1 | Regular user | add a recipe | I can keep track of the recipe | ||
| | 1 | 1 | Regular user | delete a recipe | stop keeping track of the recipe | ||
| | 1 | 1 | Regular user | list out all the recipies I have (names) | easily see what recipies I have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regular user is too broad, maybe u can try to specify the type of users
joel-lim
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job with the use cases! Just a few minor changes
| *MSS* | ||
|
|
||
| 1. `User` requests to delete a specific _recipe_ by specifying its name or index | ||
| 2. CookBuddy deletes the recipe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CookBuddy should be in ``
|
|
||
| 1. `User` requests to modify a recipe | ||
| 2. `CookBuddy` edits attributes of the recipe, and asks for user confirmation | ||
| 3. `User` confirms the edit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The MSS should end with "CookBuddy edits the attributes"
| *Extensions* | ||
|
|
||
| [none] | ||
| * 1a. The name cannot be found, or the index is invalid. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What name, and what index?
| Use case resumes at step 1. | ||
|
|
||
| [none] | ||
| * 2a. The list is empty. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be 1b rather than 2a
| === Use case: Delete recipe | ||
|
|
||
| *MSS* | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the step for the user listing recipes first
syinyichen
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your user stories make sense though there are many repeats
docs/DeveloperGuide.adoc
Outdated
| | Priority | Difficulty | As a… | I can… | So that… | ||
| | 1 | 1 | Regular user | add a recipe | I can keep track of the recipe | ||
| | 1 | 1 | Regular user | delete a recipe | stop keeping track of the recipe | ||
| | 1 | 1 | Regular user | list out all the recipies I have (names) | easily see what recipies I have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is 'recipies' the correct spelling?
| . Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed. | ||
| . Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | ||
| . Should be able to hold up to 1000 recipes without noticeable sluggishness in performance for typical usage. | ||
| . A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to state an NFR specific to your app instead of addressbook.
All NFRs are too generic.
docs/DeveloperGuide.adoc
Outdated
| | 5 | 4 | User who wants to challenge myself | have a timer/stopwatch | time myself when I cook dishes and have a "best time" feature | ||
| | 5 | 5 | User who doesn't like screens and prefers paper | print recipes as pdf/paper | I can refer to it more easily | ||
| | 5 | 5 | User who likes sharing my cooking | post my recipes and dishes on social media | share recipes and images for others to use | ||
| | 5 | 5 | User who appreciates efficiency | add a recipe directly from online | I can be efficient |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the reason 'so that I can be efficient' too vague?
docs/DeveloperGuide.adoc
Outdated
|
|
||
| *MSS* | ||
|
|
||
| 1. `User` requests to delete a specific _recipe_ by specifying its name or index |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this assuming the index of the recipe is already known? Perhaps you can list the recipes as part of MSS.
|
|
||
| *MSS* | ||
|
|
||
| 1. `User` requests to modify a recipe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the user specify the name or index of the recipe here as well? Might be inconsistent with the other use cases.
| [none] | ||
| ** `CookBuddy` throws an error message. | ||
| + | ||
| Use case resumes at step 1. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this force the user to modify the recipe, e.g. if he requests to modify unintentionally but does not have new attributes to change? CookBuddy will just keep requesting the User to modify, resulting in an infinite loop.
Consider changing it to "Use case ends".
CharmaineKoh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job on following the address book developer guide rigorously!
don-tay
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job with the architectural overview of the app.
|
|
||
| .Architecture Diagram | ||
| image::ArchitectureDiagram.png[] | ||
| image::ArchitectureDiagram.svg[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sufficient level of detail at the architecture level. Good job!
docs/DeveloperGuide.adoc
Outdated
|
|
||
| .Class Diagram of the Logic Component | ||
| image::LogicClassDiagram.png[] | ||
| image::LogicClassDiagram.svg[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sufficient level of details for logic component.
|
|
||
| .Structure of the UI Component | ||
| image::UiClassDiagram.png[] | ||
| image::UiClassDiagram.svg[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this sufficient explanation? Should there be a one-liner description to direct us on aspects of the diagram?
…factor some test classes
…3T-W12-4/main into main-adarsh-tests
…-docs update linked docs to reflect CookBuddy instead of Address Book
Docs: update DG and UG
duplicate command activity and sequence diagram
…2-CS2103T-W12-4/main into main-adarsh-updateReadme
Update PPP
Docs: Complete sharadhr PPP
…/main into main-zain * 'main-zain' of https://github.com/AY1920S2-CS2103T-W12-4/main: update DG & UG update DG, UG and PPP add manual tests for prep time and fav update Testing.adoc update DevOps.adoc update Documentation.adoc update SettingUp guide
… into main-zain * 'master' of https://github.com/AY1920S2-CS2103T-W12-4/main: remove parts of PPP Update PPP update PPP Fix checkstyle again Fix checkstyle Complete PPP fix checkstyple error, update ppp Update PPP Update PPP duplicate activity and sequence diagram Sharadh's PPP
Chore: update Ui.png
Update image which appears on Google
No description provided.