soc-pe-bot
commented
2 months ago Team's Response
Purely cosmetic.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Unclear on what working list is
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.
Under the Features section of the UG, there is a feature listed as "Delete a student from the working list".
However, there is no definition of what a working list is and so gets the user very confused.
I listed the severity as High as this affects almost all users who read it.
[original: nus-cs2113-AY2324S2/pe-interim#1837] [original labels: type.DocumentationBug severity.High]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We are not sure how the user would get confused.
Right below the sentence, it is mentioned what list the command is referring to. We used working and master list semi interchangeably throughout the user guide regardless.
Nonetheless, there is only one main list that user works with throughout the whole programme, and this is pretty clearly depicted in the UG. Not understanding "what list" should not hinder understanding of the UG much, if not at all. At worst, should be only very minor inconveniences in the legibility of the whole UG due to our choice of words for "working list".
We believe the proposed "high" severity is unwarranted as the UG is not illegible or unusable to the reader as a result of this minor and specific part of the whole 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)
- [x] I disagree
Reason for disagreement: 
The above is from the website. As mentioned in the above, this is an independently-fixable but similar bug to the duplicate mentioned by the team. So, this cannot be considered as a duplicate bug.
## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** In the team's response to the duplicate bug , they mentioned "We used working and master list semi interchangeably throughout the user guide regardless." I think this does not help their case as I think it leads to more confusion for the reader. Furthermore, the team accepts that its a bug as they use phrases like "should not hinder understanding of the UG much" (which means it does at least slightly hinder the reader), "At worst, should be only very minor inconveniences". Thus I think it doesnt make sense that the team rejects this bug as they do agree that it hinders the readers.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** In the team response they mention that it is purely cosmetic. However, that is not the case as it is not to do with the looks of the content but about missing information. This does not fall under the category of cosmetic bugs and hence is not severity of VeryLow
Under the Features section of the UG, there is a feature listed as "Delete a student from the working list". In the description of this you mention "master list"
However, there is no definition of what a master list is and so gets the user very confused.
I listed the severity as High as this affects almost all users who read it.