warrencxw / pe

0 stars 0 forks source link

Difficulty in navigating the user guide #6

Open warrencxw opened 2 years ago

warrencxw commented 2 years ago

image.png

There are hyper links in all other parts of the UG, except for the most important part which is the commands themselves.

This is even more severe as the commands span across page 4 to page 25 out of the 29 pages of the document. This makes the UG rather unusable as a user would have to use CTRL-F in order to find anything despite not knowing anything about the application whatsoever.

soc-pe-bot commented 2 years ago

Team's Response

The command words are actually hyperlinks. We do concede that this could have been more obvious but to say that we don't have hyperlinks for each command is incorrect.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Ultimately, the issue lies with the difficulty in navigating the user guide. The fact that the hyperlink is not immediately obvious is a bug on its own, since most users would not think of clicking the command words just to find the link, especially since it is not even highlighted or explained in either the section on "Using the User Guide" or "FAQ". Furthermore, the lack of consistency between the rest of the Table of Contents, where the entire header is hyperlinked, and the commands themselves where only the command words are hyperlinked is very misleading. This makes it even less likely that users would think of clicking the command words themselves to check if they are hyperlinks instead. Based on acceptance testing, this is less than acceptable to a typical user.