search

isaactodo / pe

0 stars 0 forks source link

Not enough screenshots in UG, especially in the wedding-related features #3

Open isaactodo opened 1 week ago

isaactodo commented 1 week ago

Looking at the UG, it seems that only one command example find has a screenshot attached to it. It would be nice for the other commands, especially the wedding-related commands to also have screenshots showing how the output would look like.

nus-se-bot commented 5 days ago

Team's Response

This is a duplicate of #2418 as it is regarding insufficient screenshots in the User Guide

The 'Original' Bug

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

Insufficient Use of Visuals under Commands

Description

The target users are wedding planners. They may require more visual aids or images, especially for commands like 'add', 'edit', and 'tag'. Currently under commands, only 'help' and 'find' commands have images. Hence, there is a lack of visuals for the commands.

Since many wedding planners may need at least some visual aid, this issue's severity is medium.

[original: nus-cs2103-AY2425S1/pe-interim#3293] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

This is not in scope as adding screenshots for every command would cause the UG to become very cluttered. The screenshots would be relatively similar to each other, just with different text in the input box, so it would be unnecessary to include screenshots. We have already included the input text, with some examples, under every command description.

We believe severity for this bug should be "Low" because this flaw is unlikely to affect normal operations of the product.

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.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]