teojunda / pe

0 stars 0 forks source link

User guide: Difficult to navigate to commands due to lack of hyperlinks #13

Open teojunda opened 4 months ago

teojunda commented 4 months ago

Screenshot 2024-04-19 at 5.10.58 PM.png

As the reader is looking at the overview of commands, he is likely interested in reading more detailed information about the commands by navigating to the specific section. However, it is tedious to scroll and find the correct section. It would be helpful to have a hyperlink for the each command in the overview table, so reader can quickly navigate to the correct section.

nus-se-bot commented 4 months ago

Team's Response

The user can press the home button to be brought to the first page. The table of contents (with the respective sections hyperlinked) is right below for user convenience.

We do not see a need for this extension.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As seen below, there is no home button that can allow the user to be brought to the first page. If I am missing it, then it is not clear enough for the user/ tester.

Regardless, it is a common workflow for:

  1. The user/tester to view the summary of commands to look for the command he is interested in.
  2. Visit the specific section to find out the specific details like the parameter constraints
  3. Run/test the command after he understands it.

Between step 1 and 2, he has to spend around 10s each time navigating to the correct section if there are no hyperlinks. Due to this additional difficulty and time wasted in reading the user guide, it hinders the reader/ tester from reading the user guide. Therefore, this is a valid documentation bug.

Screenshot 2024-04-23 at 3.35.02 PM.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is not a cosmetic issue. It hinders the readability of the user guide, and wastes a lot of time for the reader to scroll through the user guide to arrive at the correct section.