search

spencernah / pe

0 stars 0 forks source link

In UG, inconsistencies of index keyword used in Command Summary and Command corresponding to Feature sections #14

Open spencernah opened 2 years ago

spencernah commented 2 years ago

In Command Summary section, index is referred to as "INDEX" but it is referred to as "SEQ_NO_OF_CONTACT" in the Command corresponding to Feature section.

The term should be consistent to avoid confusion

nus-se-script commented 2 years ago

Team's Response

It is understandable that SEQ_NO_OF_CONTACT is referring to INDEX since command examples are given.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is not understandable if the user reading this is a secondary school teacher (target audience). UG is targeted at your target audience and since they are not technically trained, it is very likely that they won't be able to understand this.

Aside from readability and from an academic perspective, we can see that this consistency is maintained in AB3 UG. Observe how index is also explicitly explained in AB3 UG. Screenshots below are obtained from AB3 UG (https://se-education.org/addressbook-level3/UserGuide.html)

image.png

image.png

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]