nus-pe-bot
commented
2 years ago Team's Response
Hi there,
A short scroll would allow the reader to find the command table. The reason as to why the formatting is as such is that there is a need to preamble the commands table with the notes. Besides that there is an empty space before the commands table as this is to ensure the formatting of the table remains proper. This will not be accepted as a bug as it does not impede the understanding and the readability of the UG in any significant manner.
We hope you understand our considerations on this issue. Thank you!
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Agreed that there is the impact of this is not overly significant.
That said, this is still marked as a VeryLow severity documentation bug because it still causes a slight inconvenience and possible misunderstanding to users. It is not that scrolling to the next page is out of the question, but in the reasonably possible case that the user is not tech-savvy and is unfamiliar with the terminology used in the user guide, they may experience a minor misunderstanding regarding what a "Commands Table" is when they open up the guide and click on the Commands Table link in the table of contents, and may not know to scroll down. For reference, every other link brings the reader to a section that immediately showcases what it is titled.
This is why I suggested swapping the current positions of the 'Notes about command format' and the actual Commands Table. This is a very minor bug, but a possible bug nonetheless, for a user's experience if they are completely unfamiliar with using such software and user guides, and hence I reported it with severity.VeryLow.
Under the Commands Table section of the User Guide, the actual table of commands is not on the same page as the section title. Instead, information about the command format is shown.
This is the page linked to when readers click the 'Commands Table' link in the table of contents.
As a result, users who open the guide to find a table of commands may be mildly confused or inconvenienced. Would suggest swapping the current positions of the 'Notes about command format' and the actual Commands Table.