search

migfoo02 / pe

0 stars 0 forks source link

UG lacks relevant diagrams #14

Open migfoo02 opened 1 year ago

migfoo02 commented 1 year ago

Screenshot 2023-11-17 at 5.30.04 PM.png

This part of the UG was very wordy with lots of similar sounding commands: eaddm, eaddv, elistv etc. Some screenshots of the app would help users visualise these features better and improve readability of UG.

nus-pe-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Inconsistent usage of screenshots in UG

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.

Some features have screenshots to explain what the end result of executing a feature command looks like. For example, this is the result of executing efind n/litter n/teaching, snipped directly from the UG:

image.png

However, some other features, such as in this case the ecreate (creating an event) command, does not show at least one of the end results of executing one of the example commands. Evidently, this ecreate command contains a lot of details that needs to be showcased, which might confuse readers who wants to verify how a command execution works.

other commands that does not contain screenshots of execute results include, but not limited to:

eshow eedit eaddm eaddv

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

Their Response to the 'Original' Bug

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

Good enhancement to have, but not all commands require screenshots, especially those can be easily explained with text.

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]