Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not enough use of visuals in the User Guide #10

Open
julia-cp opened this issue Apr 19, 2024 · 1 comment
Open

Not enough use of visuals in the User Guide #10

julia-cp opened this issue Apr 19, 2024 · 1 comment

Comments

@julia-cp
Copy link
Owner

julia-cp commented Apr 19, 2024

Expected: Use of screenshots to display the expected outcomes of the commands

Actual: no screenshot provided for the outcomes of most of the commands
Screenshot 2024-04-19 at 5.30.57 PM.png

Screenshot 2024-04-19 at 5.31.06 PM.png

@soc-se-bot
Copy link

soc-se-bot commented Apr 22, 2024

Team's Response

We believe that the examples we have provided are sufficient to allow users to understand how to use the commands without the excessive use of visuals.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: There were barely any visuals in the features part of the UG.
At the very least can add some visuals for the part that cannot be described properly by typing them in.

For example here, you can see that there is a disparity between the UG and the actual screenshot, which is caused by the "..." replacing the person's detail.
This part can benefit from a screenshot.
Screenshot 2024-04-23 at 7.42.45 PM.png

This can also be said for the expected failure outcomes. A screenshot can show to the user, that their input text will turn red if it fails. This can assure the user that their input is correct if they don't see any red text on the screen.
Screenshot 2024-04-23 at 7.47.12 PM.png


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants