GithubHelp home page GithubHelp logo

pe's People

Contributors

teekaytai avatar

Watchers

 avatar

pe's Issues

Misleading error message when prefix incorrect

The error message provided when a prefix is incorrect is misleading.

In the example below, I'm attempting to edit the name and birth month of a customer, but misremembered the prefix for birth month as b instead of m. The error message instead suggests the name is incorrectly formatted. This can be an inconvenience for users since the error message is misdirecting them, making it harder for them to figure out the problem with their command.

Steps: Run edit p/12345678 n/Thomas b/10

image.png

No explanation of ability to remove tags

The UG does not seem to explain the ability to remove tags from customers by running an edit command with an empty t/ prefix. This is a fairly non-obvious behaviour that I don't think a user can figure out on their own. Without this, a user would need tro delete a customer and add it in again to remove tags.

Help link goes to github instead of website

In the help window, the link to the user guide appears to be a link to a file on github instead of the actual user guide website. This may hinder user-friendliness a bit for users not familiar with github.

Steps: Run the help command to pull up the help window

image.png

Multiple parameter example misleading

In the UG in the "Notes about the command format section", there is an explanation of what happens if multiple of the same parameter is included when only one is expected. However the example provided (phone number p/) is an example where the parameter is expected multiple times (in the edit command), so the example can be misleading.

image.png

Missing "..." in Find command format

The find command in the UG is missing a "..." after [MORE_KEYWORDS] to indicate you can have more than 2 keywords searched. The find format message in the actual app does have the "..."

image.png

image.png

UG cumbersome to use because of images

Because of the inclusion of many large images, it was fairly cumbersome trying to understand how to use the commands since I needed to scroll over multiple pages to see the format and then see the examples. For instance, the find command instructions span over 12 pages in total. The images themselves don't seem to add much value either.

Typo in edit format error message

There is a missing space between the email and the p/ prefix in the error message, causing the example command to be invalid

Steps: Run edit with no further arguments

image.png

image.png

No explanation of why edit format need two phone numbers

There does not seem to be any explanation in the UG of why two phone numbers can be input into an edit command. This confused me at first since I thought one phone number would override the other. I feel the reader would benefit from a note somewhere that the first phone number is used to identify the person to edit and the second one is the replacement phone number

image.png

The calculator feature seems out of place

Including a calculator seems to not fit well together with the other features of the app. To quote from the UG, the purpose of bobaBot is "a cheap & easy-to-use desktop application for managing bubble tea shop customers’ membership details". A calculator does not help with managing the information and it is likely any users' computer would already feature a more powerful calculator app

Phone number limited to being exactly 8 digits

Restricting a phone number to being 8 digits seems too restrictive since some people would have phone numbers that are a different number of digits long, eg. people with foreign phone numbers. There is no easy workaround to get around this problem should a user need to enter such a phone number

Images in bobaBot serves no purpose

If I understand correctly, the images in bobaBot on the right do not seem to serve any function?
If they aren't meaningful for the app, perhaps they should have been removed to allow more space to hold more useful items instead, like make the customer info area larger or to hold the calculator.

Notice the image takes up more space than the customer info
image.png

Unfulfilled NFR

The DG claims one NFR is that the app "should work when some data is missing or inaccurate". The actual app however does not allow fields like birth month to be missing when adding customers

image.png

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.