kangxinwang / pe

0 stars 0 forks source link

Flow of user guide #9

Open kangxinwang opened 3 years ago

kangxinwang commented 3 years ago

I feel that the flow of the user guide could be improved. It can get a bit confusing for the readers since readers tend to read in chronological order hence with update before done command, when clearly done command should be executed first before update command could be useful for grades, I think it would be better if done command is placed before update.

doc2.png

nus-pe-bot commented 3 years ago

Team's Response

Update command can be utilised before (e.g. updating modular credit or updating name) and/or after the done command (e.g. updating the module grade). Hence, our reasoning for putting update command before done command is valid. Putting it first is just to show that the update command can be invoked before the done command. Should there be any need to refer to the done command, there is a link (shown in the screenshot) that directs you to it, reducing confusion.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The use of the word update suggests that such command should not be used frequently and only when necessary. The change in module name is a bit insignificant if one does not allow change in module code hence even if module code is wrong and module name is correct, there is not much use. I can understand that your team wants to allow for mistakes, but clearly, you have stated restrictions like module code hence it kind of defeats the whole purpose of allowing for mistakes since module code is the more important. Hence, I feel that done should still be before update since it signifies that you have actually completed the module before this module is updated on the record. If not, an error message would be thrown, which would not have been necessary, had the done command be before.


:question: Issue severity

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

Reason for disagreement: I feel like done before update is a more logical way of how the application should work. Or maybe they should have put the done command such that it automatically updates the grade in record.