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

Confusing between SLOT and TUTORIAL keywords in the User Guide #8

Open
ncduy0303 opened this issue Nov 17, 2023 · 1 comment
Open

Comments

@ncduy0303
Copy link
Owner

ncduy0303 commented Nov 17, 2023

Description

The User Guide specifies some commands with SLOT and some commands with TUTORIAL but I am not sure whether they are refers to the same entity in the real world.

It seems like they should be the same.

Reason for severity

Confusion and minor inconvenience for readers

@nus-pe-bot
Copy link

nus-pe-bot commented Nov 20, 2023

Team's Response

Based on our target audience, we believe the target audience would know that 'slot' and 'tutorial' means the same thing.

Items for the Tester to Verify

❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: As the team said both field names (SLOT and TUTORIAL) refer to the same entity, there are no clear benefits of using inconsistent field names for the same entity (with same validation and meaning) in different commands (i.e create t/TUTORIAL and filterGroup SLOT). Instead, it can cause confusion for the readers as they attempt to understand and remember the command parameters and fields.

After more consideration, as this inconsistency can be more of a cosmetic issue rather than providing wrong information, I would suggest reducing the severity from Low to VeryLow but it should still be a valid DocumentationBug.


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

No branches or pull requests

2 participants