gzdwsu / RaiderSMA

Murphy's Wrestling Tournament Manager. Design of Info Tech Sys. Secondary Project.
1 stars 17 forks source link

Making Explanations of Commands When a User Enters "Help" Clearer and More User Friendly #4

Open ngriff43 opened 4 years ago

ngriff43 commented 4 years ago

Location: src/wrestlingtournamentcli/Main.java Starting at Line 101

Deficiency: RaiderSMA is kind of hard to figure out at first on what to do and what commands to use. The current version of the help command is a good start but it can be improved upon to make it easier for users who are not familiar with the product and guide them along. For example, the IMPORT -WRESTLERS command says "Parses the provided file for Wrestler objects". This is vague in a few ways because a user could take that as the program has provided them a file of existing wrestlers which is not the case. It also does not explain what information is required for a wrestler as well as the preferred file type the user should use in the program.

Completion Criteria: To improve upon the above issue, I would suggest that each command in the help function starting at line 101 in main.java be explained further on what the program is expecting the user to insert to be accepted. Going off of the above IMPORT -WRESTLERS command I would have the program give an example of what an acceptable wrestler file would look like. The UPDATE command does not even have a description which is an issue that needs fixed because there is a possibility that not everyone will understand what the arguments in this command is asking for. I think fixing this issue would make using this program a lot easier on a user using this program for a first time.

Author: Nathan Griffith