search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Absence of example screenshots #1264

Open nus-se-script opened 7 months ago

nus-se-script commented 7 months ago

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.

In UG, there are screenshot examples of expected output for listing savings and expenses. But for majority of other commands, there are no screenshots of examples of expected outputs.

Suggestion: Include screenshots of expected output for better clarity for users

[original: nus-cs2113-AY2324S2/pe-interim#1506] [original labels: severity.Low type.DocumentationBug]

itsmejr257 commented 7 months ago

Team's Response

Hi. Thank you for the suggestion. We do acknowledge some readers may feel that there is lack of screenshots in the UG. However, for most of the features, we believe that the addition of screenshots were not necessary as all had straightforward purposes. In this case, success messages are printed when the command is valid, and error messages are printed when the command is invalid. As such, we did not find a need to show any screenshots when the expected outputs are trivial. However, we have provided expected outputs for any printing/listing function as the added picture would show how the items should be printed/shown in order for users to identify issues when printing these outputs.

Therefore, for the trivial commands with only success/error messages, it was not a high priority to add screenshots of expected outputs for them in v2.1 as compared to the current screenshots and details we have added. However, we do agree that more screenshots can be added in future iteration. Hence, we have classified this as a NotInScope.

Duplicate status (if any):

--