search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Confusing use of monospaced 'code fonts' in user guide #1443

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.

image.png

Based on these photos, a regular user would assume monospaced text such as this will be referenced to command-related details. However, as seen from various locations such as in the screenshot below. nusmod is also shown using a monospace font which is very confusing for the users as nusmod is not really a command to add and there are no explicit or clear explanation to what the monospace fonted text actually mean.

image.png

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

shenyih0ng commented 1 year ago

Team's Response

We don't think that monospace fonts have a set meaning or defintion to it, instead it is merely a formatting style to make things clearer (in some sense due to the even spacings). Granted that perhaps we could not use monospace fonts for product title but I do not think this should be accepted as a bug as it is contingent one's formatting preference and style.

In this case, the context in which the monospace is used in is a clear indicator that it is not referring to a command.

Duplicate status (if any):

--