theodoreleebrant / pe

0 stars 0 forks source link

UG Lacking a Walkthough or Summary section #11

Open theodoreleebrant opened 4 years ago

theodoreleebrant commented 4 years ago

For a first time user, they are able to open the application but immediately being dumped information from the Features section. A walkthough section, where the user is being guided on the functionalities of the application istead of just being presented with an intimidating list of commands, would be very greatly appreciated. Putting this as Medium, because this issue is crucial to first-time users (e.g. faculty coordinators) who knows nothing about FaculType - the learning curve can be too great, especially if there are additional features to be implemented (as per the DG, there are future expansions planned).

nus-pe-bot commented 3 years ago

Team's Response

Thank you for your report! We believe a walkthrough section is unnecessary due to the straightforward nature of FaculType’s commands, and there is in fact a summary section at the bottom of the UG. Additionally, we argue that the walkthrough is not crucial, due to the fact that AB3’s UG has no such walkthrough, yet can be easily understood for first-time users.

Even if this is a problem, the severity should be low since a walkthrough is not a compulsory section in the first place and does not add much value.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: > We believe a walkthrough section is unnecessary due to the straightforward nature of FaculType’s commands, and there is in fact a summary section at the bottom of the UG.

The point of the walkthrough is to guide first-time users, and a summary would cause information overload to the users. You said in another bug report that you want to be beginner-friendly but I do not see an attempt of becoming beginner-friendly here.

Additionally, we argue that the walkthrough is not crucial, due to the fact that AB3’s UG has no such walkthrough, yet can be easily understood for first-time users.

The applications developed from AB3 have at least twice the complexity of AB3, including FaculType - at least, that's what the CS2103 instructions are. While it may be not needed for AB3, I think that it is crucial for more advanced apps.


:question: Issue severity

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

Reason for disagreement: > Even if this is a problem, the severity should be low since a walkthrough is not a compulsory section in the first place and does not add much value.

Two things: not compulsory does not mean that it is not needed. It still poses quite a sizeable amount of inconvenience for first-time users, who are clueless and getting thrown to the deep end. Second, it definitely adds much value to the UG for the aforementioned reasons.