How to use this guide should be under introduction

[hsiaotingluv]

How to use this guide should be place under introduction. Reason being as a first time user, i do not know how to navigate this guide, but i cannot find any useful instructions right at the start, instead i can only find it in page 5.

Perhaps it will be better to place the guide at the start, put a link to command summary for intermediate user, and a link to quick start for new user

[nus-pe-bot]

Team's Response

The link to how to use this guide is right at the top in the table of contents, thus the user can find it easily. Even if it actually affects the user experience, this is cosmetic at best where we just have to make that section more prominent.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: As a user reading the guide, I would like to know immediately how to navigate this guide right at the start, rather than figuring out myself where is the "how to use this guide" in the content table. There is no instruction given immediately at the beginning, only a brief summary description of the app.

Also, under the "how to use this guide" section, there is no specific instructions for the first-time / expert user. As a first time user, I would like to navigate to the Quick Start page. As an expert user, I would like to navigate to the command summary table. However, both Quick Start and Command Summary sections are strangely placed at the start of the document, even before the "how to use this guide" section.

The lack of instructions at the start causes inconvenience for the readers as I do not know how to use or navigate this document at first.

---

:question: Issue severity

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

• [x] I disagree

Reason for disagreement: A logical organisation of documentation is very important in helping readers to navigate the guide and understand the application. Without a neat and organised document, it causes inconvenience and confusion unnecessarily, hindering the readers.

Since the inconvenience can happen to both first time user and expert user, which makes up a large group of readers. The disorganization of the documentation can cause occasional inconvenience to users. Hence, severity remains at Medium.

---