DreamerDragon / pe

0 stars 0 forks source link

Inaccuracy in the diagram given #11

Open DreamerDragon opened 4 years ago

DreamerDragon commented 4 years ago

Inside the diagrams here, after Parsers specified index, it should have a condition check, if the index specified is valid, continue, else, branch back to re-enter. This would be accurate, if not it will be assumed that all indexes parsed in would be valid.

Screenshot 2020-11-13 at 5.36.53 PM.png

Screenshot 2020-11-13 at 5.39.47 PM.png

The diagram below could be an example for improving the previous two. Screenshot 2020-11-13 at 5.40.40 PM.png

nus-se-bot commented 4 years ago

Team's Response

Diagram assumes correct input by user.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Screenshot 2020-11-18 at 9.22.00 PM.png

I understand the team may treat it as a valid assumption, but at least this should be clearly stated in the text above when explaining the diagram. Also, simply stating the specified index is unclear what is meant by specified, is it just the specific index that user chooses or is it the index that fulfills the condition required for a valid input. Even it is the activity diagram for the correct index, it could be better to include the activity diagram for invalid input as well for users to better understand the whole process.

It might be misleading for users to assume that any input will be taken as a valid index but in fact this may not always be the case. Also, some member from the team includes this check while some does not, it becomes inconsistent and misleading for readers as they may assume that invalid argument will be checked if it exists, as seen by the last diagram which forms a clear comparison with the previous two.


:question: Issue severity

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

Reason for disagreement: This problem should not be ignored as the condition checking plays an important role in ensuring the functionalities of the app and reflecting them on the activity diagram helps the readers to better understand the whole process. This is not an insignificant issue that can be ignored. The severity should be at least low or medium.