search

albertarielw / pe

0 stars 0 forks source link

Glossary missing from UG #21

Open albertarielw opened 2 years ago

albertarielw commented 2 years ago

UG is meant for users (rather than developers). So glossary are more important in UG but it is missing from UG.

nus-se-script commented 2 years ago

Team's Response

All terms used in our UG are either self explanatory, or their meanings are made explicit in their accompanying sections.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Absence of glossary in user guide

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.

Description: There is no glossary present in the user guide meaning user has to take effort to search for the meaning of terms such as CLI, GUI, directory and command line.

Reason for bug level : It is inefficient for the user and time consuming as time could be saved by an an house glossary explaining key terms. Hence the very low level.

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The meaning of CLI and GUI are given at the overview section at the top of the User Guide. Most terms should be self explanatory.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Some terms used in your UG are not clear.

In fact, you yourself responded to my other bug report that you need to define the term "property" in DG because it maybe unclear and is an important term.

Glossary is very important for UG. You just need to copy paste from your DG.