nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Illustrations can be added to Beginners guide section #1894

Open nus-se-script opened 5 months ago

nus-se-script commented 5 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.


Adding screenshots here to aid the explanation can be helpful as users might not want to scroll through the entire features section:

image.png


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

Ko-Khan commented 5 months ago

Team's Response

Thanks for the feedback! Using screenshots might indeed be helpful for readers just referring to the guide without access to the app.

However, the intended use of this section is for users to try the commands themselves and visually see how they work from within the app's interface itself. To avoid unnecessary filler images for each step, we decided to omit images in favour of encouraging first-time users to try the commands out for themselves.

We believe that by omitting images, it also keeps the section more reader-friendly. Users can refer back to the short and manageable list of steps and commands they should be trying out without having to scroll across multiple images.

Duplicate status (if any):

--