nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Images are not labelled in the User Guide #1257

Open nus-se-bot opened 3 years ago

nus-se-bot commented 3 years 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.


The images, while helpful in understanding the instructions, are not labelled. In addition, instruction steps are often sandwiched between images with no clear indication of which image the step is referring to, leading to possible confusion.

image.png


[original: nus-cs2103-AY2021S1/pe-interim#2608]

sebastiantoh commented 3 years ago

Team's Response

Taking advice from our CS2101 tutor, informal diagrams, which follows right after the text, need not be labelled.

Regarding your second point, our images are consistently after the instructions, so there should be little ambiguity as to which step the images are referring to.

Duplicate status (if any):

--