Merge pull request nus-cs2103-AY1819S2#87 from kylerwsm/documentation

[v1.3] Documentation for Records and Dentist

docs/UserGuide.adoc

@@ -197,61 +197,53 @@ Saves patient 1 and patient 3 to patient 5 from the current patients list to "pa
 Writes all entries from the address book to patients1.json. +
 
 === Patient Management
+
 ==== add
 
 Adds a patient to the patients list.
 
-Format: `add PARAMETERS [t/TAG] …`
+Name, NRIC, and Date of Birth fields are compulsory. The rest are optional fields.
+
+Format: `add PARAMETERS …`
 
 Parameters:
 
 [cols=",",options=""]
 |===
-|Tag |Example
 |n/NAME |n/Keith Choo Shen Hao
 |s/SEX |s/Male
 |p/PHONE_NUMBER |p/98765432
 |e/EMAIL |e/[email protected]
 |a/ADDRESS |a/1 Pulau Tekong Besar 508449
 |ic/NRIC |ic/S1234567Z
-|age/AGE |age/25
-|dob/DATE_OF_BIRTH_DDMMYYYY |dob/28061994
+|dob/DATE_OF_BIRTH_DD-MM-YYYY |dob/28-06-1994
 |da/DRUG_ALLERGY |da/Insulin
 |nokn/NEXT_OF_KIN_NAME |nokn/Choo Debang
 |nokp/NEXT_OF_KIN_PHONE_NUMBER |nokp/97654321
 |nokr/NEXT_OF_KIN_RELATION |nokr/Brother
 |noka/NEXT_OF_KIN_ADDRESS |noka/21 Lower Kent Ridge Rd 119077
 |===
 
-
-A patient can have any number of tags.
-
-Note: If a patient’s next of kin lives at the same address, use `same` to
-indicate that.
+Note: If a patient’s next of kin lives at the same address, use `same` to indicate that.
 
 Examples:
 
-
 * `add n/John Choo p/98425871 e/[email protected] a/IDA street block 13
 #02-05 ic/S1234567H age/32 dob/26021987 nokn/Jacky Choo nokp/84875215
 nokr/Father noka/same`
 
-
 ==== delete
 
-
 Deletes the specified patient from the patients list.
 
 Format: delete INDEX
 
-
 * Deletes the patient at the specified index.
 
 * The index refers to the index number shown in the displayed patient list.
 
 * The given index must be a positive integer (e.g 1, 2 or 3…).
 
-
 Examples:
 
 * `delete 1` +
@@ -261,15 +253,12 @@ Deletes the patient shown with index 1 from the displayed list.
 `delete 2` +
 Deletes the patient shown with index 2 found using the find command.
 
-
 ==== edit
 
-
 Edits data from an existing patient.
 
 Format: `edit INDEX`
 
-
 * Goes into edit mode for the patient at the specified index shown from
 list or find command. Must be a positive integer (e.g 1, 2 or 3).
 
@@ -304,7 +293,6 @@ Edits the phone number and email of the first patient listed to become
 Edits the phone number and email of the first patient listed to become
 987654 and [email protected] respectively with a single input.
 
-
 ==== copy
 
 Makes an exact copy of a patient and adds them to the patient list.
@@ -325,91 +313,111 @@ the current patient list with a copy tag.
 Makes 4 copies of the patient at index 3 and inserts them at the bottom of
 the current patient list with a copy tag.
 
+=== Dentist Information
+
+You can specify the name you want to reflect in your patients' dental record when you create them.
+
+Format: `dentist name/YOUR_NAME`
+
+* If there is no dentist name specified, the program will prompt you to enter one.
+
+* This should only happen once, during the first startup of the application.
+
 === Patient Records Management
+
+==== goto
+
+Specifies a patient of interest, in order to modify his or her dental records and information.
+
+When the `goto` mode is active, the patient list is replaced by a dental records list. The dental records list displays all dental records of the patient of interest.
+
+To go back to the patient list, use the command `back`.
+
+Format: `goto 1`
+
+* Specifies the patient of interest to be the patient at index 1.
+
+* The given index must be a positive integer (e.g 1, 2 or 3…)
+
+* Enters all the records of the patient of interest in the `goto` mode.
+
 ==== record add
 
-Adds a new dental record for the patient.
+Adds a new dental record to the patient.
+
+Record contains the patient's personal information, name of the dentist on duty, the date of the record, and the description of the dental treatment the patient has went through during that session.
 
-Format: `record add n/NRIC d/DATE_DDMMYYYY t/TIME_HHMM p/PROCEDURE
-doc/SERVING_DENTIST det/DETAILS`
+Note: `recordadd` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified.
+
+Format: `recordadd desc/DETAILS`
+
+* The program assigns the name of the dentist stored in the dentist information
+
+* The program assigns the date of record as the date the record is created.
+
+* When records of a patient is accessed, the stored records are sorted from newest to oldest.
+
+* New dental records will appear on the top of the list upon entry.
 
 Example
-*  `record add n/S1234567H d/10022019 t/1705 p/Cleaning doc/Kyler det/Mouth
-was noticeably smelly, might have halitosis`
 
-==== record delete
+* `goto 1` - Displays dental records of the first patient in the list and hides the patient list.
 
-Format: `record delete n/NRIC INDEX`
+* `recordadd desc/Mouth was noticeably smelly, might have halitosis` - Adds a new dental record.
 
-* Deletes the patient’s dental record at the specified index.
+* `back` - Go back to the patient list.
 
-* The index refers to the index number shown in the displayed dental
-record list.
+==== record delete
 
-* The given index must be a positive integer (e.g 1, 2 or 3…)
+Deletes a dental record of a specified patient.
 
-Examples:
+Note: `recorddelete` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified.
 
-* `<<find, find>> dental Jon` +
-`record delete n/NRIC 1` +
-Deletes the 1st record from the displayed list
+Format: `recorddelete INDEX`
 
+* Deletes the patient’s dental record at the specified index.
 
-==== record edit
-Edits a patient’s dental record.
+* The index refers to the index number shown in the displayed dental record list.
 
-Format: `record edit n/NRIC INDEX`
+* The given index must be a positive integer (e.g 1, 2 or 3…)
 
+Example:
 
-* Goes into record edit mode for the specified patient at the specified
-index shown from list or find command. Must be a positive integer (e.g
-1, 2 or 3).
+* `goto 1` - Displays dental records of the first patient in the list and hides the patient list.
 
-* Input the field followed by the new value to replace the existing data.
+* `recorddelete 1` - Delete the latest dental record of the specified patient
 
-* Multiple fields can be edited in a single input or across multiple
-inputs.
+* `back` - Go back to the patient list.
 
-* When editing tags, the existing tags of the patient will be removed i.e
-adding of tags is not cumulative.
+==== record edit
 
-* All tags can be removed by keying in t/ without specifying any tags
-following it.
+Edits a patient’s dental record.
 
-* Exit the edit mode by entering "done".
+Note: `recordedit` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified.
 
-Example:
+Format: `recordedit INDEX desc/DETAILS`
 
-* `<<find, find>> dental n/Jon +
-record edit n/S1234567H 1 +
-doc/Debang +
-det/new details +
-done` +
-Edits the first dental record under the patient Jon and replaces the old
-doctor and detail fields with the new Debang and new details data.
+* Edits the patient's dental record at the specified index.
+
+* The index refers to the index number shown in the displayed dental record list.
 
-==== record copy
-Makes an exact copy of a patient’s dental record.
+* The given index must be a positive integer (e.g 1, 2 or 3…)
 
-Format: `record copy n/NRIC INDEX`
+* The new description stated in the command will replace the old description in the specified dental record.
 
 Example:
 
+* `goto 1` - Displays dental records of the first patient in the list and hides the patient list.
 
-* `record copy n/S1234567H 2` +
-Makes a copy of the patient’s dental record at index 2 and inserts it at
-the bottom of the current dental records with a copy tag.
+* `recordedit 1 desc/corrected description` - Modifies the description of the first dental record of the specified patient.
 
+* `back` - Go back to the patient list.
 
 === Teeth Management
 
 ==== Brief Description
 
-
-TeethHub complies with the most popular standard of the
-three the Dental Numbering Systems utilised in Dentistry - The
-Universal Numbering System.
-
+TeethHub complies with the most popular standard of the three the Dental Numbering Systems utilised in Dentistry - The Universal Numbering System.
 
 ==== The Universal Numbering System
 
@@ -425,32 +433,25 @@ mandibular left third molar, designated number 17, and continues along
 the bottom teeth to the right side. Each tooth has a unique number or
 letter, allowing for easier use on keyboards.
 
-
 ==== Creating and Editing Teeth Layout
-There are two templates provided by TeethHub: primary and
-permanent.
 
-All primary or permanent teeth in template will all be present and
-healthy by default.
+There is one template provided by TeethHub: permanent teeth.
 
+All permanent teeth in template will all be present and healthy by default.
 
 * To create a new teeth layout for patient:
 
-** `teeth add n/NRIC <Template>`
-
-** Note that if a teeth layout already exist, a warning will be thrown to
-confirm your overwriting intention.
+** The program automatically creates a new permanent teeth template for new patients added.
 
 * To edit a new specific tooth:
 
-** `teeth edit n/NRIC t/TEETH_LABEL s/STATUS -d/DESCRIPTION`
+** `goto 1` - Specifies patient 1 to edit his or her teeth status. Enters the record edit mode.
 
-** Valid <Teeth Label> are letters A through T (case-insensitive, for
-primary teeth), and numbers 1 - 32 (for permanent teeth).
+** `teeth edit t/TEETH_LABEL s/STATUS` - Edits the status of the indicated tooth of patient.
 
-** Note that if a teeth layout does not exist, a new layout will be created
-based on the teeth label group used, before the edit is applied on the
-newly created teeth layout.
+** `back` - Exits the record edit mode, and returns to the patient list.
+
+** Valid <Teeth Label> are numbers 1 - 32 (permanent teeth).
 
 ** <Status> reflects overall health of the indicated tooth, and valid
 <Status> are "healthy", "problem" and "absent".
@@ -476,12 +477,11 @@ Example:
 * `list` +
 Shows details of all patients.
 
-
 * `list dental` +
 Shows details of patient's dental records.
 
-
 ==== find
+
 Shows patients whose data contains any of the given keywords according to a specified parameter.
 
 Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]`
@@ -493,15 +493,12 @@ Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]`
 
 Example:
 
-
 * `find a/Yishun` +
 Show all the people with an address containing the keyword Yishun.
 
-
 * `find dental cleaning` +
 Shows all the dental records with cleaning
 
-
 ==== sort
 Sorts the records by an input parameter in an input order.
 
@@ -552,15 +549,14 @@ application in reverse chronological order.
 
 Format: `history`
 
-
 === undo
+
 Undo the latest command.
 
 Format: `undo`
 
 * The following commands are affected by undo: add edit delete and clear.
 
-
 Examples:
 
 * `<<delete, delete>> 1` +
@@ -572,7 +568,6 @@ Examples:
 The undo command fails as there are no undo-able commands executed
 previously.
 
-
 * `<<delete, delete>> 1` +
 `<<clear, clear>>` +
 `undo` (reverses the clear command) +
@@ -623,13 +618,10 @@ Format: `exit!`
 To increase data redundancy and reduce the risk of data being lost,
 you will be able to synchronise your data with a cloud account.
 
-
 == Spell-Checker Functionality [Coming in v2.0]
 
-
 Automatically correct an improperly typed command(e.g. sirt to sort).
 
-
 == Frequently Asked Questions (FAQ)
 
 *Q*: How do I transfer my data to another Computer?