chuahjiajie / pe

0 stars 0 forks source link

Explanation of Aliases is Too Late Into the Documentation #18

Open chuahjiajie opened 2 months ago

chuahjiajie commented 2 months ago

image.png

As seen from the image above, the edit feature already features aliases. However, that is only mentioned almost right at the end of the documentation. Users reading the guide may be confused as to what is meant by aliases.

nus-se-bot commented 2 months ago

Team's Response

It is mentioned in the top note of "Main feature" section.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Although it is stated, the alias section itself serves no practical purpose being that far down the documentation.

There is no denying that the in depth explanation of what aliases are misplaced and would aid the reader far greater if it was explained to the reader before facing it in the "add" command and "edit" command sections.

This issue should minimally be in the "VeryLow" category as even in the off chance it does not cause inconvenience to the reader, from a design perspective this is flawed.