pe's Issues
Error message could be clearer
DG: UML Diagram Mistakes -- sequence diagram footbox
Keying in some garbage input for volume attribute of add fluid results in a 0ml drink being added
DG: UML Diagram Mistakes -- class diagram
Different behaviour when almost similar (invalid) inputs are entered for add workout
When optional attributes /d and /t are keyed in without a space in between, the program accepts the input as long as the other attributes are correctly keyed in. But when /d and /t are keyed in with a space in between, the program rejects the input. I think the behaviour should be more consistent since the inputs are almost identical
Program picks the first date input if duplicate dates are keyed in
DG: Missing Architecture diagram and an overall high level description of the architecture
The design and implementation section immediately goes into descriptions of each component, class and functionality. It will be good to first have an overall high level architecture diagram and introduction + brief overview of the various components/classes and how they fit together as a cohesive whole.
Dummy bug report
UG is unnecessarily long and includes many details that are redundant/overwhelming especially to a first time user
While I see why your team would want to include this section into the UG, I feel that it is too overwhelming especially for a first time user reading this UG to understand all the limitations and many restrictions in their text-based input. The user would probably figure out some of these errors along the way as he uses the product through error messages.
The UG as a whole was personally too complicated for a first time reader trying to test your product.
DG: UML diagram comments
Somewhat inconsistent error messages when random commands are entered
No functionality for completing a scheduled workout, not sure what the purpose of meal and fluid library is
Once the date/time passes for the scheduled workout, is it automatically assumed that the workout is completed (if it was not deleted beforehand)? And would the calories automatically be counted into that day's calories burnt?
Meal and fluid library seems redundant, there are now 2 ways to add meals and fluids into the app which makes it complicated
DG: Instructions for manual testing section is too long
The instructions for manual testing section take up ~50% of your DG length. I don't think it is necessary to have so much detail of all the different test cases, sample inputs and expected outputs -- it makes it overlap with the UG and there's way too much detail, making it overwhelming.
Unclear error message for delete schedule
Possible improvement to error message for list schedule command
UG: No v2.1 user stories
Unclear error message
Workout schedule does not reschedule overdue workouts that are scheduled today but already past the current time
UG: Add scheduled workout with activity breakdown is too complicated
Optional parameters required for add fluid
UG: Better ordering of example usage and expected outputs
Possible improvement
UG help message did not explicitly state that one can omit fluid calories in the add command if the fluid is already in the library
Workout on a future date can be added without scheduling command
DG: Lack of Object diagrams
Scrolling through your DG, I see all class diagrams and sequence diagrams. Would be good if you could include some object diagrams for specific implementation example inputs. Otherwise all of it is a fairly bigger picture/higher level view.
UG: Missing detail on how to use BMI and calorie intake calculator
Does not describe in sufficient detail how to use the BMI calculator/calorie intake calculator.
Seems like more details were given in the DG manual testing section instead, for instance: how the activity level works (is 1 the lowest or highest activity level and won't it be quite subjective across different individuals as well?)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.