search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Discrepancy in info boxes #4104

Open nus-se-script opened 11 months ago

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

Some info tips are enclosed in blue outlined boxes (pg 6, 11) while others are not (eg pg16, 19). This discrepancy could cause users to miss the info that is not enclosed in boxes, as they do not stand out from the rest of the text in the UG.

image.png (info in the above screenshot is enclosed in a box, pg11)

image.png (info in the above screenshot is not enclosed in a box, pg19)

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

ivyy-poison commented 11 months ago

Team's Response

This is a minor cosmetic issue in our user guide. We do not believe that users will miss the information, as there is a clear info button to the left of that paragraph. Furthermore, it is less than 3 lines of words, and is surrounded by an info box to ensure that it is not buried amongst a giant wall of text.

Duplicate status (if any):

--