search

medajet / pe

0 stars 0 forks source link

Insufficient screenshots in UG #18

Open medajet opened 2 years ago

medajet commented 2 years ago

There are no screenshots in the UG showing examples of command execution. Some should be added to show the before and after of command executions to better illustrate what to expect for the user.

image.png

nus-pe-bot commented 2 years ago

Team's Response

This is a suggestion, as the addition of screenshots of the application before and after execution do not add a lot of value to the reader, and also do not hinder the reader. The lack of visuals is made up for with more descriptions of the flags and the examples given. It is also not an issue with cosmetics. We did include other visuals to aid the user as shown below.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The above screenshot is the only one in the entire UG. While it is true that screenshots should not be overdone, a few can be added for major features to illustrate the expected outcome for users especially when large numbers of parameters are used for the command. Taking editapplicant for example:

image.png

A screenshot would have been useful here to illustrate the final statement, considering how wordy the entire section is. This is not limited to editapplicant, considering that other commands like addapplicant and addjob also suffer the same problem.