jiaweiteo / pe

0 stars 0 forks source link

[UG] Unneccsary images in features section. #14

Open jiaweiteo opened 3 years ago

jiaweiteo commented 3 years ago

Too many repetitive images under the features section. There may not be a need to have an image for each specific command, even though there is only a minor change.

Etc. add ct/s and add ct/w can just have one image instead of 2 different images since they are showing very similar details.

image.png

nus-se-bot commented 3 years ago

Team's Response

The images are not repetitive. Adding a warehouse requires the address field while adding a supplier requires the email field.

In addition, these two images are placed under separate sections and for each section, the UG has minimally one image and at most two images. As such, it would not be considered as repetitive.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I believe that the images are uneccessary repetitive as there is no need to have many different individual images that has minor changes for the same command. For example, the delete command have 4 different images in the UG with little changes to the images. (Only the result display section is changed) I feel that it is unecessary to add an image per one specific command in the UG as it made the user guide uncessary long and hence, this should be considered a documentation bug. (E.g. The delete command can have one image only to show readers what the command generally does, instead of having 4 similar images that have little changes to it.)

image.png


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]