search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Link to glossary should be provided #4123

Open nus-pe-bot opened 4 years ago

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

A link to the glossary should be provided here, as I was slightly confused about the child-tag and tag management before I saw that there was a glossary!

Screenshot 2020-11-13 at 5.22.34 PM.png

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

chan-j-d commented 4 years ago

Team's Response

It was a decision not to include links to the glossary for the terms used.

This was inspired by the CS2101 lesson 4.2 on user guides where the activity "User Guide Journey of Discovery worksheet" had an activity which told us to analyse the GIMP online user guide at this link. Right at the beginning, there are terms like "GNU" which are not linked to the glossary. However, the term is in the glossary (visit this link and search for the word "GNU").

Our reasoning is that as the number of words in the glossary increases, and as these words are used more often in the user guide itself, there would be a large number of links within the user guide. This can be very frustrating for users viewing the guide as they might accidentally click on one of the links, sending them to the glossary which forces them to search for where they were prior to clicking on the link.

Duplicate status (if any):

--