nus-se-script
commented
11 months ago Team's Response
Although we included an example of the format of duration in our edit command section of the UG, we did not explicitly state the exact format that should be entered by users.
We are choosing LOW for serverity in this case as 1) Most users can continue using the product with the examples given where the duration is in integer form and handling alphabets could be a future expansion. 2) Since the bug was reported only in phase II, hence we only focus on the documentation part, which is that we did not explicitly state format
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Low]
Originally [severity.High]
- [x] I disagree
Reason for disagreement: Since it was classified as a documentation bug, I agree that we should just focus on the documentation part. However, even in only the quality of documentation, I disagree that the omission of sufficient instructions for duration's format is only a low severity. The entire program is able to crash when I input the wrong format - which was not stated anywhere. In the example provided, '30mins' is also very ambiguous and not very self-explanatory. Thus, I do not think the consequent conclusion can be that "most users can continue using the product" when no instructions are given and the effects of it make the product rather unusable.
I do feel that the issue itself is quite severe purely looking at documentation - clarity and preciseness is required in instructions. It is not about their error message in this reasoning. Rather, due to the omission in the UG, the consequence is a flaw that affects all users who might eventually add duration, and makes the product almost unusable since it crashes. Going off of this, I thus felt it was severe enough to warrant a "High" for documentation.
Add recipe specifies that you can add duration as an optional tag. However, no examples were really concretely provided for it, so it is quite unclear on what exactly are the parameters for the duration - whether numbers or letters, or need units. I had to try it myself to see what works, and it actually crashed the program.
It just cannot be overlooked in this case, since the program does crash. I classified it as a docu bug because I wanted to give benefit of doubt! But it is a feature flaw, that could be as severe as the other ones, as you don't handle the exceptions.