afroneth / pe

0 stars 0 forks source link

Informal phrasing of terms in DG #10

Open afroneth opened 3 years ago

afroneth commented 3 years ago

Hi, I was reading through the DG section 4.1.3 and I noticed some inappropriate phrasing under the section "Alternative choice".

DG.PNG

In the picture above, I felt that words like "almighty" and "fatter" class are not proper software engineering terminologies and hence they should be rephrased, especially since this is a formal developers guide. Other developers may not understand what you are trying to say from these terms, so maybe it is better to use proper explanation to bring your point across.

nus-se-bot commented 3 years ago

Team's Response

Thank you for the report. The terms used in this section is used with reference to these online materials:

Team chose [response.Rejected]

Reason for disagreement: The online materials cited are blogposts by fellow computer scientists, which in my opinion may not hold a lot of credibility. Perhaps it would be better to use terms specifically taught in CS2103T or used in official software engineering textbooks.

However, if "almighty" and "fat" are indeed used in official software engineering textbooks, then I would suggest placing these terms in the "Glossary" section of the textbook as "almighty" and "fat" may be prone to ambiguous meaning. Currently, the "Glossary" section does not contain the meanings of these words.

Severity would be "VeryLow" as the user guide is still readable.