search

DonnyS57 / pe

0 stars 0 forks source link

Glossary is extremely short. #11

Open DonnyS57 opened 2 years ago

DonnyS57 commented 2 years ago

Screenshot 2021-11-12 at 5.27.12 PM.png

Developers that are relatively new to programming might not understand the terms used in the guide such as CLI, GUI, JSON, etc.

nus-pe-bot commented 2 years ago

Team's Response

The glossary is written to dispute terms that may be ambiguous. Terms such as CLI, GUI and JSON are commonly used acronyms in software design and can be easily searched up.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Screenshot 2021-11-18 at 1.34.23 PM.png

I feel that since these acronyms are extensively used throughout the developer's guide, there should be a definition dedicated to defining these terms. There are also other ambiguous terms that are used within the developer's guide that should be defined clearly to avoid misconceptions, such as appointments.

I would have accepted downgrading this issue to a very low severity but a rejection might be too dismissive of the potential issue.