Pinran-J / pe

0 stars 0 forks source link

Missing table of content label on DG. #6

Open Pinran-J opened 1 year ago

Pinran-J commented 1 year ago

Bug found:

Table of content label is missing in DG but present in the UG. Thus, causing inconsistency across the two documents. Since no table of content label for DG, there are no hyperlinks to go back to the top of the document, thus, making the document hard to navigate.

Screenshots:

Table of content header/label present in UG:

image.png

Table of content header/label absent in DG:

image.png

nus-pe-bot commented 1 year ago

Team's Response

The inconsistency between DG and UG, does not hinder the reader from reading the documents.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The team argues that the inconsistency does not "hinder" the readers from reading the documents.

However, this is false because this inconsistency will slow the readers down and cause great inconvenience for the users.

Explaination:

In the UG, a Table of Contents label and its corresponding hyperlinks are included. With this, users can now navigate the 26 pages of UG better by clicking on hyperlinks to bring them to the Table of Contents for ease of navigation.

Screenshot:

image.png

Users might then be left confused and inconvenient when they find out that the longer 43 pages of DG does not contain a Table of Contents label and therefore, no hyperlinks for them to navigate the long document.

The user might have expected the same convienient feature on the DG after going through the UG, thus, slowing the readers down, hindering them and causing them inconvenience.

This should be at the very least a severity.VeryLow as it is a cosmetic issue, however, due to the lack of Table of Contents causing inconvenience for users, should be severity.Low