Skip to content
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

Feedback for user guide (V0.0) #22

Open
okkhoy opened this issue Mar 21, 2017 · 0 comments
Open

Feedback for user guide (V0.0) #22

okkhoy opened this issue Mar 21, 2017 · 0 comments

Comments

@okkhoy
Copy link

okkhoy commented Mar 21, 2017

General comments

  • Consider providing your command summary as a table
  • Please read the project scope and requirements and check what is missing from your user guide.

About us page.

  • formatting issues with Wentong's description!

User guide

  • releases page leads to blank (noticed that you haven't made the release for v0.2 :-P)

  • Add command

    • it is confusing why we should use two s/ for start date and time, similarly why two e/ can you think of clubbing them together?
    • What about task with just end date? (please check the project requirements, you need to support 3 types of tasks)
    • your example doesn't follow the format you specify? which works? which doesn't?
  • Edit command

    • first issue, the way you identify the fields is not consistent with your add format, ideally, for users it is better to have a single format for using throughout the product.
    • second issue, the -name -start etc are closer to Unix command style. remember that Jim is a windows user?
    • third issue, again, the example doesn't follow the format you specify, rather in this case, the format seems incomplete.
  • Find command

    • why would you want to make search case sensitive? the reason some one may want to search for a task is because, they may have forgotten the exact task name. if you make search case sensitive, the objective of search is lost.
  • Delete command

    • What do you mean by "Irreversible" for this one alone?
  • Clear command

    • Is this reversible?

User stories

  • Do I assume you are implementing all user stories? Some of the prioritisation is not very clear. E.g. Edit and List are lower priority tasks. But they are must have features.

Use cases

  • In general these are good, no complaints 👍
  • I can only suggest you to think of more extensions if possible

Non functional requirements

  • Please note, if you are morphing from Addressbook Level 3 or Level 4, the program doesn't run with Java 7, you need Java 8
  • Handle exceptions may not be truly NFR, but its ok to have it recorded somewhere (better here than no where :-P)
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

No branches or pull requests

1 participant