search

datn02 / pe

0 stars 0 forks source link

Too much navigation in Quick Guide section #12

Open datn02 opened 2 years ago

datn02 commented 2 years ago

Quick-start part of the UG takes too much deviation from the section, e.g users have to click many hyperlinks to navigate into different sections to away from the quick guide section.

This takes too much time, and renders the meaning of the "quick guide" useless since it is not quick at all.

image.png

soc-pe-bot commented 2 years ago

Team's Response

Thank you for your suggestion.

This quick guide of terminus is to help the user by giving a high level overview of how the program generally work, to prevent an overwhelming of contents from the commands part throughout the rest of the UG.

This section is great for users that needed to jump straight into the related section instead of scanning through the whole UG to determine how everything works.

In addition, majority of the testers do not think the quick guide was an issue and CS2101 agree that this section actually helps in the overall understanding of the UG.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I don't think this should be rejected at all. First, the section is called "quick-guide". Henceforth, it should have some idea of guiding the user to quickly get used to the program within just a few lines of instructions. However, half of the instructions in the quick-guide section (5 to be precise) would always make the user navigate away to longer sections to add new modules/be familiar with some commands of the program. Reading the quick guide but having to jump around for reference to quick-start a program is not a very pleasing experience. It should only be consolidated into 1 section with no navigation to anywhere else, and at least have some example commands so that users expect what comes next, instead of making users read more than necessary to "quick-start". Secondly, if the team's intention of the quick guide is not so, then how and where can users start from to make sense of what the program input and what it does? If the quick-guide is just for the overview of what the program can do, users may be better off reading the table of contents and introduction section, to navigate to wherever they want to proceed. The quick-guide in this case then serves little purpose for the user.

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.High]

Reason for disagreement: Should be at least medium severity, for the reasons mentioned above.