garfield-oo7 / pe

0 stars 0 forks source link

Not enought use of graphics in User guide #11

Open garfield-oo7 opened 1 year ago

garfield-oo7 commented 1 year ago

As a user of the application I like that you have made use of hyper links wherever necessary, however one thing that as a user of the application felt that there weren;t enough use of graphics made, while you did provide, example, providing an image of the expected output can be a nice addition as well.

image.png

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Lack of visuals

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


The UG only had 1 picture, I believe that adding more visuals such as screenshots could be useful in helping the readers understand.

As a user I felt that this portion was hard to understand, adding a image here would have been useful.

Screenshot 2022-11-11 at 5.13.13 PM.png


[original: nus-cs2103-AY2223S1/pe-interim#3555] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

  • It is not feasible to show multiple visuals for each feature, especially for features that are easily understandable. If a feature has 3-5 screenshot visuals, the user would need to do a lot of scrolling and that would make the experience less convenient.

    Items for the Tester to Verify

    :question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: while not feasible to show all the graphics. I think there should be so more graphics. Right now in your current documentation you have just made use of 1 graphic, which is what the application looks like when you start the application.

For example you could show the before and after of what the data would like look once you add in an applicant.

For edit command you could have just shown what happens when you edit the name of the applicant, you just need to show 1 example, not all of them.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]