JulietTeoh / pe

0 stars 0 forks source link

Missing Glossary Section in the DG #19

Open JulietTeoh opened 3 years ago

JulietTeoh commented 3 years ago

Having a glossary section in developer's guide would be nice in order to explain some technical terms like Java, HDB, predicates etc...

This is to provide more clarity to the developer who is reading the DG and might be new to software engineering.

nus-pe-bot commented 3 years ago

Team's Response

We actually do have a glossy section in the developer's guide. Nevertheless, our team believes that terms such as Java is common knowledge to the developer, and does not add value by including it in the dg.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I can accept your statement that "Java is common knowledge to the developer, and does not add value by including it in the dg".

However, you did not include the meaning of terms like HDB, Condo, Landed in your developer's guide. You cannot expect that developers have the same knowledge about properties as property agents, and if they don't have a glossary to get a common understanding of such knowledge, how would they be able to implement more advance features to help property agent?

Thus, by not having the glossary explain technical terms like HDB, Condo that only property developers would know about, there is no common understanding between developers and property agents about noteworthy terms. Thus, the bug report still holds.

This bug should be of severity.Medium because of the reasons stated above.

Screenshot 2021-04-20 at 1.32.07 PM.png