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

Add terms to glossary #25

Merged
merged 7 commits into from
Oct 4, 2023
Merged

Conversation

CJ-Lee01
Copy link

@CJ-Lee01 CJ-Lee01 commented Oct 4, 2023

Added non-functional requirements to the NFR list for command syntax and argument syntax. (removed as they aren't exactly NFRs)

Added the definition for commands and arguments in the glossary.

@CJ-Lee01 CJ-Lee01 added the type.Documentation Items related to or requiring documentation (custom label) label Oct 4, 2023
@CJ-Lee01 CJ-Lee01 added this to the v1.1 milestone Oct 4, 2023
@CJ-Lee01 CJ-Lee01 requested review from a team, McNaBry and wxwern and removed request for a team October 4, 2023 05:03
@wxwern
Copy link

wxwern commented Oct 4, 2023

Based on our tutorials, specific requirements of the command might not qualify as NFRs... perhaps others can provide some input on the matter.

@McNaBry
Copy link

McNaBry commented Oct 4, 2023

Based on our tutorials, specific requirements of the command might not qualify as NFRs... perhaps others can provide some input on the matter.

Hm yeah I feel that command syntax requirements would be a functional requirement since its a must-have for the program we are developing? Although we could phrase it as a NFR by saying commands should be short and simple enough, limited to around 10 characters for better user experience and readability. The rest I don't think it matters as much?

@CJ-Lee01
Copy link
Author

CJ-Lee01 commented Oct 4, 2023

Since this is confusing I'll just remove all the syntax NFR and keep the glossary.

@CJ-Lee01 CJ-Lee01 enabled auto-merge October 4, 2023 10:29
@wxwern wxwern changed the title Add NFRs and terms to glossary Add terms to glossary Oct 4, 2023
Copy link

@McNaBry McNaBry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, looks good to me

@CJ-Lee01 CJ-Lee01 merged commit fad7334 into AY2324S1-CS2103T-W08-3:master Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Items related to or requiring documentation (custom label)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants