nus-pe-bot
commented
2 years ago Team's Response
The rationale for putting the Prefix Summary at the end of the document is so that it is close to the Command Summary, as we feel that this is where it will be of most use to the reader. This way, the reader can have a comprehensive summary on all the commands and prefixes they can use in our application in one part of our UG. To get to know all the parameters used in our commands, there is a Parameter Summary earlier on in our UG before all the features are introduced. Therefore, we feel that the organisation of our UG is justified in this case.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: As a reader of the UG, and as someone who is looking to test the product, it was very inconvenient to have to scroll all the way to the end of the document to get the parameters necessary to enter the commands. Perhaps adding the prefixes to the parameter summary would have been a better choice.
The tutor can try to test the product and check for whether the placement of the prefix table makes testing unnecessarily difficult. I certainly believe so.
As such, this remains a bug in my eyes.
This proved very problematic, it would be significantly better to know the prefixes before reading the rest of the document rather than after.