search

Capeguy / pe

0 stars 0 forks source link

Developer Guide - Activity Diagram in Section 3.1.1, 3.2.3 should be more detailed #24

Open Capeguy opened 4 years ago

Capeguy commented 4 years ago

In Developer Guide Sections 3.1.1 and 3.2.3, there are two unlabelled figures each. This issue is referring to the activity diagrams.

For nodes with "NOVA Shows Error", it would be more understandable if it was indicated what kind of error or exception that will be thrown.

nus-pe-bot commented 4 years ago

Team's Response

I believe that action in activity diagram should only show "An action is a single step in an activity. " In this case, "NOVA shows error" is a still single step. There is no need to give more information than necessarily.

Furthermore, I'll have to downgrade the severity from "Medium" to "VeryLow" as this does not affect the usage of NOVA in any way, which is a criteria for "VeryLow".

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Inadequate documentation

:question: Issue severity

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

Reason for disagreement: Inadequate documentation