Merge pull request #166 from leezhanpeng/file-adjustments

Adjust user guide and datafile name

docs/UserGuide.md

@@ -40,6 +40,22 @@ MediSync is a **desktop app specifically used for head nurses to manage staff an
 
 1. Refer to the [Features](#features) below for details of each command.
 
+--------------------------------------------------------------------------------------------------------------------
+## Glossary
+
+MediSync strives to streamline the storage and identification of contacts, focusing on essential information that are critical in medical contexts.
+
+Here are some definitions that are noteworthy when using MediSync.
+
+| Term                | Explanation                                                                                                                                                                                                                                                                                                                                                                  |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Role                | The **role** of a person in the contact list is either `Doctor`, `Nurse`, or `Patient`. When we use the word staff, we are implying both `Doctor`s and `Nurse`s.                                                                                                                                                                                                             |
+| Affiliation         | With staff members providing care to specific `Patient`s, there is a need to establish an association between staff members and `Patient`s. We use **affiliations** to denote such relationships. Such relationships can never be one-sided in MediSync, and it will not exist between staff members or between `Patient`s.                                                  |
+| Affiliation History | Having some level of history-taking is vital in tracking medical care. The use of **affiliation history** is to track past staff members that had affiliations with a particular `Patient`, and vice-versa. MediSync allows for the deletion of these history, but existing affiliations can never be deleted from the affiliation history until the affiliation is severed. |
+| Shift Days          | **Shift days** is an attribute unique to staff members. For simplicity, the current version of MediSync monitors the workdays of each staff member in blocks of days.                                                                                                                                                                                                        |
+| Next of Kin         | The **Next of Kin** attribute is meant for `Patient`s. Having a method of contact with the `Patient`s next of kin is vital in medical care.                                                                                                                                                                                                                                  |
+| Specialisation      | Exclusively for `Doctor`s, the **specialisation** attribute offers added information about each doctor, enabling the appropriate doctor to be matched with patients having diverse requirements.                                                                                                                                                                             |
+
 --------------------------------------------------------------------------------------------------------------------
 
 ## Features
@@ -105,7 +121,7 @@ Format: `list`
 
 Edits an existing contact in the contact list.
 
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/AFFN_NAME_NAME]…​`
+Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/AFFN_NAME]…​`
 
 * Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
 * At least one of the optional fields must be provided.
@@ -139,7 +155,7 @@ Examples:
 
 ### Add affiliations of a staff/patient: `addaffn`
 
-Format: `addaffn INDEX a/AFFN_NAME [a/AFFN_NAME_NAME]…`
+Format: `addaffn INDEX a/AFFN_NAME [a/AFFN_NAME]…`
 
 Add affiliations to staff/patients indicated by the given `INDEX` without deleting existing affiliation.
 
@@ -151,7 +167,7 @@ Add affiliations to staff/patients indicated by the given `INDEX` without deleti
 * Adding patient A to affiliation of staff B, will result in adding staff B to affiliation of Patient A.
 * Multiple affiliations can be added.
 * At least one affiliation field must be provided.
-* `AFFN` is specified as full name of a person in the contact list.
+* `AFFN_NAME` is specified as full name of a person in the contact list.
 
 Examples:
 * `addaffn 1 a/John` add `John` to affiliation of 1st person in the contact list.

src/main/java/seedu/address/model/UserPrefs.java

@@ -14,7 +14,7 @@
 public class UserPrefs implements ReadOnlyUserPrefs {
 
     private GuiSettings guiSettings = new GuiSettings();
-    private Path addressBookFilePath = Paths.get("data" , "addressbook.json");
+    private Path addressBookFilePath = Paths.get("data" , "medisync.json");
 
     /**
      * Creates a {@code UserPrefs} with default values.

src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json

@@ -9,5 +9,5 @@
       "z" : 99
     }
   },
-  "addressBookFilePath" : "addressbook.json"
+  "addressBookFilePath" : "medisync.json"
 }

src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json

@@ -7,5 +7,5 @@
       "y" : 100
     }
   },
-  "addressBookFilePath" : "addressbook.json"
+  "addressBookFilePath" : "medisync.json"
 }

src/test/java/seedu/address/logic/LogicManagerTest.java

@@ -46,7 +46,7 @@ public class LogicManagerTest {
     @BeforeEach
     public void setUp() {
         JsonAddressBookStorage addressBookStorage =
-                new JsonAddressBookStorage(temporaryFolder.resolve("addressBook.json"));
+                new JsonAddressBookStorage(temporaryFolder.resolve("medisync.json"));
         JsonUserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(temporaryFolder.resolve("userPrefs.json"));
         StorageManager storage = new StorageManager(addressBookStorage, userPrefsStorage);
         logic = new LogicManager(model, storage);

src/test/java/seedu/address/storage/JsonUserPrefsStorageTest.java

@@ -73,7 +73,7 @@ public void readUserPrefs_extraValuesInFile_extraValuesIgnored() throws DataLoad
     private UserPrefs getTypicalUserPrefs() {
         UserPrefs userPrefs = new UserPrefs();
         userPrefs.setGuiSettings(new GuiSettings(1000, 500, 300, 100));
-        userPrefs.setAddressBookFilePath(Paths.get("addressbook.json"));
+        userPrefs.setAddressBookFilePath(Paths.get("medisync.json"));
         return userPrefs;
     }