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.

Sign up for GitHub

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

Update NFR and Glossary in DeveloperGuide.md #34

Closed
wants to merge 2 commits into from
Closed

Update NFR and Glossary in DeveloperGuide.md #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c647c0f
Update UserGuide.md
JerryWang0000 Mar 6, 2024
abeab66
Merge branch 'master' of https://github.com/JerryWang0000/tp into upd…
JerryWang0000 Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,16 +394,24 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Non-Functional Requirements

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
2. Should be able to answer a user's prompt within 1 second.
3. Should require less computational resources to allow users with older hardware can use the app without trouble.
4. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
5. Should be able to provide error messages when a user does not type in expected prompts.
6. Should be able to store the users' information securely without leakage.
7. Should provide understandable and informative responses whenever a user provides a prompt.
8. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
9. A user without much experience in admin commands should be able to handle the usage in rather short time.
*{More to be added}*
Comment on lines +405 to 406
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you might have missed out an empty line between this two lines. Currently the two lines have been combined into 1 line in the preview.


### Glossary

* **Mainstream OS**: Windows, Linux, Unix, MacOS
* **Private contact detail**: A contact detail that is not meant to be shared with others
* **Users' Information**: Same as above
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps you could specify the possible information just like for Mainstream OS where the OS are being listed down?

* **Error Message**: A prompt printed to the user that the program execution cannot run normally and specifies the most possible cause
* **MSS**: Main Success Scenario

--------------------------------------------------------------------------------------------------------------------

Expand Down
Loading