search

pwjj2000 / pe

0 stars 0 forks source link

DG does not explain important abbreviations and terms in Glossary #8

Open pwjj2000 opened 1 year ago

pwjj2000 commented 1 year ago

Examples: MSS

nus-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Insufficient glossary in both UG and DG

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

For DG

image.png

For UG image.png

Explainations used are insufficient and not clear

In both cases there are many jargons used such as API or Syntax which a teacher would simply not understand. More needs to be explained so that reader would have clearer understanding of documents.

[original: nus-cs2103-AY2223S1/pe-interim#2996] [original labels: type.DocumentationBug severity.Low]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: I still think that the lack of explanation of certain terms and abbreviations used cause more than just a 'minor inconvenience' to readers. Abbreviations like MSS can stand for many things. A Google search on "MSS abbreviation" does not yield results even close to "Main Success Scenario".