search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

The footnotes(?) for the introduction section in the user guide is confusing and unclear. #1140

Open nus-pe-bot opened 3 years ago

nus-pe-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.

In the introduction section of the user guide, some words have footnotes/subscript (I'm unsure of the exact name) as seen here:

image.png

image.png

image.png

Instead of these being explained at the bottom of the page, it is stated in point form after the introduction paragraph in the same font and font size. This is a confusing layout for the user as the points don't make sense without referring to the exact words/phrases (refer to screenshots above). Perhaps it could be a different font size or format to distinguish it from a normal paragraph. Here is the screenshot:

image.png

[original: nus-cs2113-AY2021S2/pe-interim#1140] [original labels: severity.Medium type.DocumentationBug]

zikunz commented 3 years ago

Team's Response

Thank you for your reply! :)

However, we are unable to accept it as a bug.

In the introduction, "cross-platform", "best-selling product(s)" and "command terminal" have footnotes as there require some explanations. The content of the explanation is in the same section so the user can refer to it easily. The fact of having the same font and same size is not a problem as there are no universal rules saying footnote content has to be in a different font and size. Please look at pictures in websites such as https://github.com/rstudio/bookdown/issues/793 and https://github.com/notable/notable/issues/523.

Duplicate status (if any):

--