blackonyyx / pe

0 stars 0 forks source link

Sequence flow diagram is extremely verbose and complex #10

Open blackonyyx opened 3 years ago

blackonyyx commented 3 years ago

As the point of a sequence flow diagram is to be concise and give the reader a good understanding of the inner workings, consider breaking this diagram up into smaller steps and procedures, building up to the completion of the command. Screenshot 2020-11-13 at 5.27.30 PM.png

Similarly with the edit sequence diagram, the excess amount of detail causes it to become conversely complex to understand

nus-se-bot commented 3 years ago

Team's Response

Agreed; the "parse" and "get" operations can be abstracted out to another diagram.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: As this command is a critical functional requirement of the product even being functional.

The fact that it is very confusing to figure out as to exactly what is going on, causes major issues as a potential maintainer of the code base to potentially identify an error in the command due to adding new functionalities or performing refactoring. As such, due to the nature of this command as a critical feature to every other feature in the product, causes the severity of this issue to be increased to medium. (would be low otherwise)

Screenshot 2020-11-18 at 6.06.57 PM.png