Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary Explanation that may still be hard to understand #5575

Open
nus-pe-bot opened this issue Apr 19, 2024 · 1 comment
Open

Glossary Explanation that may still be hard to understand #5575

nus-pe-bot opened this issue Apr 19, 2024 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Apr 19, 2024

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.



From a normal hiring manager point of view, the explanation for terms like CLI and GUI may still be too technical or vague to understand. Like interacting your computer with keyboard, it does not really tell the user much about CLI and may even confuse them and make them think that a document processing app like Word is also use CLI because you use keyboard in it.

image.png


[original: nus-cs2103-AY2324S2/pe-interim#5562] [original labels: type.DocumentationBug severity.VeryLow]
@yashpola
Copy link
Contributor

yashpola commented Apr 20, 2024

Team's Response

Though subjective, we feel the explanation for the terms are already suitable for Hiring Managers. Even still, the terms Command Line Interface and Graphical User Interface also are hyperlinked to very thorough explanations when they are first mentioned.

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment