soc-se-bot
commented
1 year ago Team's Response
This is clearly not severity high:
"A flaw that affects most users and causes major problems for users.i.e., makes the product almost unusable for most users"?
This is the format we followed:
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
No Table of Contents
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.
DG has no TOC so the reader has to scroll down through the document to have an outlook of the document.
[original: nus-cs2113-AY2223S2/pe-interim#2538] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
A table of contents was never mandated in the user guide nor the developer guide.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue response Team chose [`response.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** I agree that the original severity is inaccurate. However, the severity of "very low" seem like the team is downplaying the inconveniences of lacking atable of contents.  According to this benchmark, lacking a table of contents with working anchor links cause quite a big inconvienience for the reader, whenever we want to scroll to a specific section. This is not just purely a "cosmetic" error, but an actual inconveinience. The severity should have been downgraded to `severity.Medium` or at least a `severity.Low`.
It was mentioned in the submission requirements that working anchor links and table of contents should be present in the PDF for both UG and Dg. However, they were absent in both of them. This results in major inconveinicence for the reader.