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

Add non functional requirements for developer guide #39

Merged
merged 3 commits into from
Sep 28, 2024
Merged

Add non functional requirements for developer guide #39

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af497b7
Add non functional requirements for developer guide
Incogdino Sep 28, 2024
b261dc5
Add full stops to the end of non functional requirements sentences
Incogdino Sep 28, 2024
8846957
Merge branch 'master' into branch-updateDevGuideNonFunctionalRequirem…
DesSnowy Sep 28, 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
19 changes: 14 additions & 5 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,11 +317,20 @@ 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 `17` 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.

*{More to be added}*
1. Should work on any mainstream OS as long as it has Java 17 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.
4. Commands should be easy to remember.
5. Ui should be easy to navigate and intuitive.
6. KonTActs should be easy to use for new users.
7. The system should work on both 32 bit and 64 bit environments.
8. Contact details are securely stored.
9. The application should have an uptime of at least 99.9% to ensure constant availability for users.
10. The application should automatically save data after every change to avoid data loss in case of a crash.
11. There should be proper documentation for the code and application usage to assist developers in future updates.
12. Error messages should be descriptive, providing users with clear guidance on how to resolve the issue.
13. Searching for or filtering contacts should take less than 5 seconds.
14. Stored contacts are persisted between sessions.

### Glossary

Expand Down