Skip to content

Conversation

@AdarshChugani
Copy link

No description provided.

| 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

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

Copy link

@joel-lim joel-lim left a 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
Copy link

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
Copy link

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.
Copy link

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.
Copy link

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*

Copy link

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

Copy link

@syinyichen syinyichen left a 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

| 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

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.

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.

| 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

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?


*MSS*

1. `User` requests to delete a specific _recipe_ by specifying its name or index

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

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.

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".

Copy link

@CharmaineKoh CharmaineKoh left a 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!

Copy link

@don-tay don-tay left a 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[]
Copy link

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!


.Class Diagram of the Logic Component
image::LogicClassDiagram.png[]
image::LogicClassDiagram.svg[]
Copy link

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[]
Copy link

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?

muhd97 and others added 30 commits April 13, 2020 22:33
…-docs

update linked docs to reflect CookBuddy instead of Address Book
duplicate command activity and sequence diagram
Update 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.