Yuvaraj0702 / pe

0 stars 0 forks source link

Absence of glossary in user guide #10

Open Yuvaraj0702 opened 1 year ago

Yuvaraj0702 commented 1 year ago

Description: There is no glossary present in the user guide meaning user has to take effort to search for the meaning of terms such as CLI, GUI, directory and command line.

Reason for bug level : It is inefficient for the user and time consuming as time could be saved by an an house glossary explaining key terms. Hence the very low level.

nus-pe-bot commented 1 year ago

Team's Response

The meaning of CLI and GUI are given at the overview section at the top of the User Guide. Most terms should be self explanatory.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Your claim that most terms should be self-explanatory is not well-backed. The target audience for your user guide would be middle-aged approx 35+ yrs old real estate agents and terms such as directory and command line and strings are not something the dev team can expect a middle-aged real estate agent to understand. Their profession and education don't require them to know this and the tester believes it's an over assumption to do so.

image.png

Furthermore, this image from the CS2103T website using hard-to-understand terms is a bug. In addition, there is no glossary section in the UG as well which also reduces understandability. This should have warranted a medium or low but the tester was lenient and gave a very low as this problem can be solved by searching the internet. However, that is still a hassle for the user and that is why it is a bug. The tester respectfully disagrees with the dev team on this bug.