search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Images used in the UG for features examples is redundant/ineffective for value adding. #1231

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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 Features in the UG were explained with many examples and result-of-command lists but fails to show the difference between the before-command state of the list and the after-command state of the list, hence is not useful to the user to learn about how the commands change the state of the HealthContact lists.

May even add to the clutter of the UG rather than guide users, since they can't tell the difference anyways.

image.png

Above Figure: User viewing the image can't tell the difference between before-command and after-command since only after-command is shown.

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

SpecOps2016 commented 2 years ago

Team's Response

Technically the result of the command is shown, which is more important thean showing before execution of the command.

Duplicate status (if any):

--