Merge pull request #220 from ejnan/ug-update

Minor changes to user guide

docs/DeveloperGuide.md

@@ -597,7 +597,7 @@ specified otherwise)
 
   Use case ends.
 
-**Use case: `UC04 - Edit a patient records`**
+**Use case: `UC04 - Edit a patient's records`**
 
 **MSS**
 
@@ -706,15 +706,37 @@ specified otherwise)
 #### Non-Functional Requirements
 
 1.  Should work on any _mainstream OS_ as long as it has Java `11` installed.
-1.  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.  The codebase should be well-structured and well-documented to facilitate future maintenance and enhancements.
-1.  The application should only support a single user.
-1.  The data should be stored locally and should be in a human editable text file.
-1.  The software should work without requiring an installer.
-1.  The software should not depend on any specific remote server.
-1.  The product should be available as a single JAR file of size 100MB or below.
-1.  The product should process a user input command within 2 seconds.
+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.  The user interface should be intuitive and easy to navigate.
+5.  The codebase should be well-structured and well-documented to facilitate future maintenance and enhancements.
+6.  The application should only support a single user.
+7.  The product needs to be developed in a breadth-first incremental manner over the project duration.
+8.  The data should be stored locally and should be in a human editable text file.
+9.  The software should follow the Object-oriented paradigm primarily.
+10.  The software should work without requiring an installer.
+11.  The software should not depend on a specific remote server.
+12.  The GUI should work well for standard screen resolutions 1920x1080 and higher, and, for screen scales 100% and 125%.
+13.  The GUI should be usable (i.e., all functions can be used even if the user experience is not optimal) for,
+     resolutions 1280x720 and higher, and, for screen scales 150%.
+14.  The product should be available as a single JAR file of size 100MB or below.
+15.  The web documents saved should be a PDF file of size 15MB or below.
+16.  The final JAR/PDF files should not be bloated unnecessarily.
+17.  The DG and UG should be PDF-friendly, without any expandable panels, embedded videos, animated GIFs etc.
+18.  The use of third-party frameworks/libraries/services is allowed only if they, are free, open-source (this
+     doesn't apply to services), and have permissive license terms; do not require any installation by the user.
+19.  The product should process a user input command within 2 second.
+20.  The application should comply with Singapore's Personal Data Protection Act (PDPA) by implementing appropriate measures to protect the personal data of patients, such as securing data storage, restricting access to authorized personnel only, and ensuring proper disposal of data when no longer needed.
+
+### Glossary
+
+* **CLI**: Command Line Interface
+* **GUI**: Graphical User Interface
+* **JSON**: JavaScript Object Notation
+* **Mainstream OS**: Windows, Linux, Unix, MacOS
+* **NRIC**: Identity card number of the National Registration Identity Card, used as a unique identifier for
+    patients in Nursing Address Book
+* **Patient**: A person receiving medical services at a hospital
 
 --------------------------------------------------------------------------------------------------------------------
 

docs/UserGuide.md

@@ -79,11 +79,11 @@ We hope you find this guide helpful in your journey to mastering NAB.
 ### Icons used in this guide
 Here are the icons used in this guide and their meanings:
 
-| Icon                          | Meaning                                                                           |
-|-------------------------------|-----------------------------------------------------------------------------------|
-| :exclamation:**Caution**      | Indicates a caution or warning. Typically, these are common errors made by users. |
-| :information_source: **Note** | Provides additional information.                                                  |
-| :bulb:**Tip**                 | Provides additional tips for you to master the application.                       |
+| Icon                                | Meaning                                                                           |
+|-------------------------------------|-----------------------------------------------------------------------------------|
+| <div>:exclamation:**Caution**</div> | Indicates a caution or warning. Typically, these are common errors made by users. |
+| :information_source: **Note**       | Provides additional information.                                                  |
+| :bulb:**Tip**                       | Provides additional tips for you to master the application.                       |
 
 
 
@@ -114,7 +114,8 @@ Back to [Table of Contents](#table-of-contents)
    <br>
    <br>
    <div markdown="block" class="alert alert-info"> :information_source:
-   _Ensure you have the necessary permissions to execute commands. For Windows Users, running the command prompt as an administrator may be
+   **Ensure you have the necessary permissions to execute commands.** <br> 
+   _For Windows Users, running the command prompt as an administrator may be
    required. If you encounter permission issues on Mac/Linux, you might need to use `chmod +x nab.jar` to make the file 
    executable._
    </div>