LimZiJia / pe

0 stars 0 forks source link

Misleading example for edit in UG #11

Open LimZiJia opened 4 months ago

LimZiJia commented 4 months ago

Under edit the example at the end is written in .md. This does not align with how the actual application looks. Perhaps screenshots would be a better fit here.

UG

image.png

Actual

Before:

image.png

After:

image.png

nus-se-script commented 4 months ago

Team's Response

We wrote it in .md as we wanted to demonstrate data shown in the result display box, as users may reference that instead of looking for the edited contact (for which they may have to scroll through the entire list of contacts). We can include both for better clarity.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I do not see the advantage of this over a clear screenshot. Looking at the data is for more advanced users. The UG should help any user.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a purely cosmetic issue. There is a misalignment of how the app looks and how you choose to showcase it in the UG.