Merge pull request #32 from ampan98/update-guides

JQChong · web-flow · commit 31377ae0ab9a · 2021-03-10T14:03:08.000+08:00
Update guides to be more consistent
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -255,17 +255,17 @@ and the required means of communication.
 Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
 
 | Priority | As a …​                                 | I want to …​                                      | So that I can…​                                                      |
-| -------- | ------------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------- |
-| `* * *`  | new user                                   | see usage instructions                               | refer to instructions when I forget how to use the App                 |
-| `* * *`  | user                                       | add a new person                                     |                                                                        |
-| `* * *`  | user                                       | delete a person                                      | remove entries that I no longer need                                   |
-| `* * *`  | user                                       | find a person by name                                | locate details of persons without having to go through the entire list |
-| `* * *`  | user                                       | filter contacts by tag                               | minimize chance of sending emails to the wrong recipient               |
-| `* * *`  | user                                       | specify preferred mode of contact                    | maximize chance of recipient seeing the information                    |
-| `* * *`  | user                                       | blacklist a contact                                  | reduce dissemination of information to people who do not want it       |
-| `* *`    | user                                       | hide private contact details                         | minimize chance of someone else seeing them by accident                |
-| `* *`    | user with many contacts                    | assign each contact an additional optional remark    | remember contacts more accurately                                      |
-| `* *`    | user with many contacts                    | sort contacts by name                                | locate a contact easily                                                |
+| -------- | ------------------------------------------ | ---------------------------------------------------- | ----------------------------------------------------------------------- |
+| `* * *`  | new user                                   | see usage instructions                               | refer to instructions when I forget how to use the App                  |
+| `* * *`  | user                                       | add a new contact                                    |                                                                         |
+| `* * *`  | user                                       | delete a contact                                     | remove entries that I no longer need                                    |
+| `* * *`  | user                                       | find a contact by name                               | locate details of contacts without having to go through the entire list |
+| `* * *`  | user                                       | filter contacts by tag                               | minimize chance of sending emails to the wrong recipient                |
+| `* * *`  | user                                       | specify preferred mode of contact                    | maximize chance of recipient seeing the information                     |
+| `* * *`  | user                                       | blacklist a contact                                  | reduce dissemination of information to people who do not want it        |
+| `* *`    | user                                       | hide private contact details                         | minimize chance of someone else seeing them by accident                 |
+| `* *`    | user with many contacts                    | assign each contact an additional optional remark    | remember contacts more accurately                                       |
+| `* *`    | user with many contacts                    | sort contacts by name                                | locate a contact easily                                                 |
 
 *{More to be added}*
 
@@ -277,10 +277,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 **MSS**
 
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+1.  User requests to list contacts
+2.  SpamEZ shows a list of contacts
+3.  User requests to delete a specific contact in the list
+4.  SpamEZ deletes the contact
 
     Use case ends.
 
@@ -292,7 +292,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 * 3a. The given index is invalid.
 
-    * 3a1. AddressBook shows an error message.
+    * 3a1. SpamEZ shows an error message.
 
       Use case resumes at step 2.
 
@@ -320,19 +320,18 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 **MSS**
 
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User request to add a specific person with a preferred mode of contact
-4.  AddressBook adds the person
+1.  User requests to list contacts
+2.  SpamEZ shows a list of contacts
+3.  User requests to edit the preferred mode of contact for a contact
+4.  SpamEZ edits the contact
     
     Use case ends.
 
 **Extensions**
 
 * 2a. The list is empty.
 
-  Use case ends.    
-
+  Use case ends.
 
 **Use case: Blacklist a contact**
 
@@ -363,24 +362,24 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 **MSS**
 
 1. User requests to list contacts.
-2. AddressBook shows a list of contacts.
+2. SpamEZ shows a list of contacts.
 3. User requests to add an optional remark to a specific contact in the list.
-4. Addressbook adds the optional remark to the specific contact.
-5. Addressbook shows the updated list of contacts.
+4. SpamEZ adds the optional remark to the specific contact.
+5. SpamEZ shows the updated list of contacts.
    
    Use case ends.
 
 **Extensions**
 
 * 3a. The given index is invalid.
 
-  * 3a1. Addressbook shows an error message.
+  * 3a1. SpamEZ shows an error message.
     
     Use case resumes at step 3.
 
 * 3b. The user enters details in the wrong format.
 
-    * 3b1. Addressbook shows an error message and the corect format.
+    * 3b1. SpamEZ shows an error message and the correct format.
 
       Use case resumes at step 3.
 
@@ -389,8 +388,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 **MSS**
 
 1. User requests to sort the contact list by name in alphabetical order.
-2. AddressBook sorts the contact list.
-3. AddressBook displays the updated contact list.
+2. SpamEZ sorts the contact list.
+3. SpamEZ displays the updated contact list.
    
    Use case ends.
 
@@ -438,17 +437,17 @@ testers are expected to do more *exploratory* testing.
 
 1. _{ more test cases …​ }_
 
-### Deleting a person
+### Deleting a contact
 
-1. Deleting a person while all persons are being shown
+1. Deleting a contact while all contacts are being shown
 
     1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.
 
     1. Test case: `delete 1`<br>
        Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.
 
     1. Test case: `delete 0`<br>
-       Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.
+       Expected: No contact is deleted. Error details shown in the status message. Status bar remains the same.
 
     1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)<br>
        Expected: Similar to previous.
@@ -467,7 +466,7 @@ testers are expected to do more *exploratory* testing.
 
 1. Filter the list of contacts based on the keywords provided.
 
-    1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.
+    1. Prerequisites: List all contacts using the `list` command. Multiple contacts in the list.
 
     1. Test case: `find n/Alex Bernice` <br>
        Expected: A list of contacts whose name contains `Alex` **or** `Bernice`. The filter is case-insensitive, so `Alex` will match with `aLeX` too, for instance.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -3,7 +3,8 @@ layout: page
 title: User Guide
 ---
 
-AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+SpamEZ is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI).
+If you can type fast, SpamEZ can get your contact management tasks done faster than traditional GUI apps.
 
 * Table of Contents
 {:toc}
@@ -14,9 +15,9 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
-1. Download the latest `addressbook.jar` from [here](https://github.com/AY2021S2-CS2103-T16-1/tp/releases).
+1. Download the latest `spamez.jar` from [here](https://github.com/AY2021S2-CS2103-T16-1/tp/releases).
 
-1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+1. Copy the file to the folder you want to use as the _home folder_ for SpamEZ.
 
 1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
    ![Ui](images/Ui.png)
@@ -26,11 +27,11 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 
    * **`list`** : Lists all contacts.
 
-   * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
+   * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the contacts list.
 
    * **`delete`**`3` : Deletes the 3rd contact shown in the current list.
    
-   * **`tag`**`tag n/John Doe t/small` : Adds tag to contact John Doe in Address Book.
+   * **`tag`**`tag n/John Doe t/small` : Adds tag to contact John Doe.
 
    * **`clear`** : Deletes all contacts.
    
@@ -83,7 +84,7 @@ Format: `help`
 
 ### Adding a person: `add`
 
-Adds a person to the address book.
+Adds a person to the contacts list.
 
 Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
 
@@ -97,13 +98,13 @@ Examples:
 
 ### Listing all persons : `list`
 
-Shows a list of all persons in the address book.
+Shows a list of all contacts.
 
 Format: `list`
 
 ### Editing a person : `edit`
 
-Edits an existing person in the address book.
+Edits an existing person in the contacts list.
 
 Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
 
@@ -140,7 +141,7 @@ Examples:
 
 ### Deleting a person : `delete`
 
-Deletes the specified person from the address book.
+Deletes the specified person from the contacts list.
 
 Format: `delete INDEX`
 
@@ -149,45 +150,47 @@ Format: `delete INDEX`
 * The index **must be a positive integer** 1, 2, 3, …​
 
 Examples:
-* `list` followed by `delete 2` deletes the 2nd person in the address book.
+* `list` followed by `delete 2` deletes the 2nd person in the contacts list.
 * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
 
-### Adding tags to contacts : `tag`
+### Adding tags to a contact : `tag`
 
 Labels a contact based on his or her attributes.
 
 Format: tag n/NAME t/TAG
 
-### Assign additional nicknames to contacts : `name`
+### Assign an additional nickname to a contact : `name`
 
 Adds an optional nickname to the contact.
 
 Format: name INDEX [n/NAME]
 
-### Blacklist contacts : `blist`
+### Blacklist a contact : `blist`
 
 Blocks specific contacts, to specify that they do not want to be contacted.
 If the contact is already blacklisted, they will be un-blacklisted. 
 
 Format: blist INDEX
 
+* Changes the blacklist status of 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, …​
+
 ### Filter contacts: `filter`
 
 Filters shown contacts based on the given keyword(s).
 
 Format: filter [keyword1, keyword2, …]
 
-
-
 ### Clearing all entries : `clear`
 
-Clears all entries from the address book.
+Clears all entries from the contacts list.
 
 Format: `clear`
 
 ### Adding a new remark or replacing an existing remark : `remark`
 
-Adds a new remark to the specified person from the address book. 
+Adds a new remark to the specified person in the contacts list. 
 If the person already has a remark, the new remark will replace the
 existing remark.
 
@@ -197,14 +200,13 @@ Format: `remark INDEX r/REMARK`
 * The index refers to the index number shown in the displayed person list.
 * The index **must be a positive integer** 1, 2, 3, …​
 
-
 Example:
 
 `remark 3 r/Currently on Stay Home Notice`
 
 ### Sort entries by name : `sort`
 
-Sort the entries in the address book by name in ascending alphabetical order.
+Sort the entries in the contacts list by name in ascending alphabetical order.
 
 Format: `sort`
 
@@ -216,14 +218,14 @@ Format: `exit`
 
 ### Saving the data
 
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+SpamEZ data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
 
 ### Editing the data file
 
-AddressBook data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+SpamEZ data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
 
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
+If your changes to the data file makes its format invalid, SpamEZ will discard all data and start with an empty data file at the next run.
 </div>
 
 ### Archiving data files `[coming in v2.0]`
@@ -235,7 +237,7 @@ _Details coming soon ..._
 ## FAQ
 
 **Q**: How do I transfer my data to another Computer?<br>
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous SpamEZ home folder.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -244,14 +246,14 @@ _Details coming soon ..._
 Action | Format, Examples
 --------|------------------
 **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague`
+**Blacklist** | `blist INDEX`<br> e.g., `blist 2`
 **Clear** | `clear`
 **Delete** | `delete INDEX`<br> e.g., `delete 3`
 **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
+**Filter** | `filter [keyword1,keyword2,...]`<br> e.g., `filter[Computing, Student]`
 **Find** | `find [n/NAME_KEYWORDS] [t/TAG_KEYWORDS]`<br> e.g., `find n/James Jake t/classmates`
-**Tag** | `tag n/NAME t/TAG`<br> e.g., `tag n/Jane Bo t/Student`
-**Name** | `name INDEX [n/NAME]`<br> e.g., `name 3 [n/Jo]`
-**Blacklist** | `blist INDEX`<br> e.g., `blist 2`
-**Filter** | `filter [keyword1,keyword2,...]`<br> e.g., `filter[Computing, Student]` 
-**List** | `list`
 **Help** | `help`
+**List** | `list`
+**Name** | `name INDEX [n/NAME]`<br> e.g., `name 3 [n/Jo]`
 **Remark** | `remark INDEX r/REMARK`<br> e.g., `remark 5 r/Currently on Leave of Absence`
+**Tag** | `tag n/NAME t/TAG`<br> e.g., `tag n/Jane Bo t/Student`
