nus-pe-script
commented
2 months ago Team's Response
We believe this is definitely a valid error in documentation visuals.
However, this should not hinder the understanding of the sequence diagram. The purpose of this diagram is to show the flow of the function calls and we believe this flow is reflected clearly with all the function calls specific to the ArchiveCommands component. When the reader sees this diagram without the title, it should be obvious what the diagram is reflecting. It is clear that the problem is purely cosmetic and should not affect understanding of the sequence diagram at all, especially since the whole component is about archiving. The diagram description above and follow-on explanations about the component make it obvious that the title is a small typo too.
Hence, we propose a severity of low instead as the wrong title is cosmetic and should not affect comprehension of the ArchiveCommands component, let alone the usage of the whole DG.
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
As seen in the diagram and as seen from the sentence above the diagram, this sequence diagram is for calling archiveStudent, however the title of the sequence diagram is calling editStudent and editing gender. This is very severe and will significantly detract developers when reading the DG. Hence, i am assigning a severity of medium.