search

damiwee / pe

0 stars 0 forks source link

Developer guide: Architecture diagram line #9

Open damiwee opened 4 weeks ago

damiwee commented 4 weeks ago

The line from user to pulse pilot should be dotted since it is from outside.

image.png

Sample from course material: image.png

nus-se-bot commented 3 weeks ago

Team's Response

Architecture diagrams have no standard format, and it is up to the group to dictate what it looks like.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Despite the course material indicating that teams are allowed to set their own standards, it is not an excuse to overlook consistency issues in the diagrams.

For example, in the team's diagram, when interacting with an external entity (storage and output file), dotted line was used. However, the interaction between the external entity user and internal entity pilot used a solid line.

Such inconsistencies can create confusion and might leave readers asking "why"?

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is not just a cosmetic issue but appears to be a deliberate decision made by the dev team (refer to their response) that can result in confusion for some external developers reading the documentation. However, in hindsight, I would now argue that the label be low instead of my initial medium severity label, since in this case, it is unlikely to cause a lot of confusion but neither is it a cosmetic bug.