search

tim-pipi / pe

0 stars 0 forks source link

Ambiguous Link #2

Open tim-pipi opened 12 months ago

tim-pipi commented 12 months ago

image.png

The CLI hyperlink (2nd bullet point) seems to lead me to the following part of the UG. image.png

The user may be confused as to why this is linked to this part since previously CLI links to the definition page in Wikipedia.

nus-pe-script commented 12 months ago

Team's Response

The first link to the wikipedia page informs the user of what a CLI is, the second one which is under Interface Layout, introduces the CLI that we are using, thats why this CLI link is under the same point as the Interface Layout

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Hi there,

Thank you for your explanation regarding the hyperlinking of "CLI" in the User Guide. I understand the intention behind linking "CLI" to the "2. Command Input and Output Boxes" section in the context of explaining our application's interface. However, I'd like to suggest some modifications for clarity and user experience:

Consistency in Hyperlinking: Throughout the User Guide, hyperlinks seem to provide additional or external information about the text that is hyperlinked, for example, previous instances of the term (like "Command Line Interface") link to an external source like Wikipedia. The sudden change in hyperlinking "CLI" to an internal section can be confusing and may be perceived as a broken or incorrect link. This is especially true since the "CLI" hyperlink leads to the "2. Command Input and Output Boxes" section (in the middle of the "Interface Layout section") which does not seem to provide additional information about "CLI" itself.

Clear Section Titles and Links: It is crucial that hyperlinks match the expectation set by the text. If the section title is "2. Command Input and Output Boxes," but the hyperlink text is "CLI," it creates a disconnect. Users might expect to learn more about CLI in general, not about how it is specifically implemented in our application.

Simplifying for Better User Experience: Given the potential for confusion, it might be more user-friendly to remove the hyperlink from this instance of "CLI" and instead provide a clear textual reference to the relevant section of your application. This approach would reduce confusion and streamline the user's journey through the guide.

Considering these points, I believe that revising the hyperlink for "CLI" to ensure consistency and clarity is crucial in enhancing the overall user experience with the documentation. Thus, I believe that this is a valid bug.