[CS2113T-F08-2] HealthVault #12

MingShun98 · 2021-03-03T11:18:55Z

HealthVault is a desktop app for managing doctor, nurse and patient information, optimised for use through the command line interface. This app is for the head nurse of a hospital, if the user can type fast, it is better than a traditional GUI app.

MingShun98 · 2021-03-03T11:19:10Z

HealthVault is a desktop app for managing doctor, nurse and patient information, optimised for use through the command line interface. This app is for the head nurse of a hospital, if the user can type fast, it is better than a traditional GUI app.

lyndseyBeil · 2021-03-21T15:29:10Z

src/main/java/seedu/duke/exceptions/patient/duplicateIDException.java

+
+import seedu.duke.exceptions.DukeException;
+
+public class duplicateIDException extends DukeException {


I detect that this code is problematic. According to the Bad practice (BAD_PRACTICE), Nm: Class names should start with an upper case letter (NM_CLASS_NAMING_CONVENTION).
Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).

okkhoy · 2021-03-30T23:56:53Z

Updated the name and reopened the PR

JethroPhuah

Left a review

JethroPhuah · 2021-03-31T02:29:35Z

docs/DeveloperGuide.md

+
+### 
+
+### **UI component**


I think an accompanying visual diagram would be useful here?

JethroPhuah · 2021-03-31T02:31:19Z

docs/DeveloperGuide.md

+2.  The user input determines which type of functionalities will be
+    > accessed by the user.
+
+**Staff Menu**


I feel like the explanation are too detailed and lengthy and the explanation is too unnecessarily long.

JethroPhuah · 2021-03-31T02:33:40Z

docs/DeveloperGuide.md

+
+11. Data is written and saved.
+
+**Viewing all Staff**


Too many examples ?

ManikaHennedige · 2021-03-31T02:30:34Z

docs/DeveloperGuide.md

+    > amongst the classes. This will be elaborated in the Common Classes
+    > component
+
+> (Insert UI UML diagrams)


Don't forget!

ManikaHennedige · 2021-03-31T02:32:01Z

docs/DeveloperGuide.md

+allows for a structure that helps store details from user input in the
+format that we want to be saved.
+
+[Objects:]{.ul}


Not sure what this is for - is it to control the css formatting? It seems to be rendering on the page directly, though

ManikaHennedige · 2021-03-31T02:33:50Z

docs/DeveloperGuide.md

+    > Duke.run() calls UI.scanInput() to read the user's input from the
+    > command line.
+
+2.  The user input determines which type of functionalities will be


Good, comprehensive and detailed explanation for the general running of the application :)

ManikaHennedige · 2021-03-31T02:39:29Z

docs/DeveloperGuide.md

+
+add \[Staff ID\] \[name\] \[age\] \[specialisation\]
+
+> Getting User Input


Very nicely detailed, but I think a UML diagram would be nice to have here, for a pictorial overview

ManikaHennedige · 2021-03-31T02:40:41Z

docs/DeveloperGuide.md

+UI, StaffUI classes will be accessed, and the following sequence of
+actions is called to prompt execution result to user:
+
+add \[Staff ID\] \[name\] \[age\] \[specialisation\]


Personally, it was difficult for me to identify what the input format was - in terms of the code required. Perhaps backtick formatting could be used to convey what the input commands are?

ManikaHennedige · 2021-03-31T02:47:03Z

docs/DeveloperGuide.md

+        > PatientUI.deletePatientMessage() to print a message notifying
+        > the user that the Patient has been deleted.
+
+5.  Saving the current list of patients


These steps are very well detailed, but maybe consider trimming them to only include the important/essential parts? Considering that the method being explained is 'deleting a patient', maybe more focus could be drawn to the actual Patient and related classes rather than the Parser functions? Maybe there could be some reorganization so that Parser has a section explaining its implementation separately

ManikaHennedige · 2021-03-31T02:48:50Z

docs/DeveloperGuide.md

+    a.  Using the case statements in patientParse, the command find is
+        > identified.
+
+    b.  patientParse then calls lengthCheck() and iDParser() to scan the


Same as above - maybe not important here!

lamzf1998 · 2021-03-31T02:30:24Z

docs/DeveloperGuide.md

+Our application utilises many layers of abstraction which allows each
+individual component to be self contained yet able to work with other
+components. The Main Menu component allows direct access to other
+components as shown in the diagram.


Diagram does not seem to be loading on the page.

lamzf1998 · 2021-03-31T02:36:40Z

docs/DeveloperGuide.md

+distinct functionalities: Adding, Deleting and Listing. For Nurse
+Schedules/ Patients / Staff related features, there is an additional
+search functionality.
+


For the features description, I think sample inputs and outputs can be included for users to be understand how the function would work.

lamzf1998 · 2021-03-31T02:43:28Z

docs/DeveloperGuide.md

+    > handle any additional user commands that are inputted to access
+    > features within that particular instance.
+
+### **Staff-related Features**


I think visual representations of the sequence of actions can be included to accompany the description.

lamzf1998 · 2021-03-31T02:55:42Z

docs/DeveloperGuide.md

@@ -1,3 +1,1140 @@
+**Developer Guide**
+===================
+


The DG is well written with many details about the functions and implementations. While the diagrams are lacking, you can still add them on later. I think the formatting of the DG can also be standardised to look neater but overall it was a well written documentation. Good job! And shoutout to MsKwek MingShun98!

RainyCodeWizard

Overall have minor changes that needs to be changed

RainyCodeWizard · 2021-04-01T01:11:08Z

docs/DeveloperGuide.md

+which will be elaborated on in the section [[Common
+Classes]{.ul}](#common-classes)
+
+### 


There is an Extra "###" in the document. Please consider removing it.

RainyCodeWizard · 2021-04-01T01:13:54Z

docs/DeveloperGuide.md

+
+Shared functionalities are placed within the Common Classes component
+which will be elaborated on in the section [[Common
+Classes]{.ul}](#common-classes)


It shows Common Classes {.ul} on screen. If the {.ul} is not necessary please remove them.

RainyCodeWizard · 2021-04-01T01:15:55Z

docs/DeveloperGuide.md

+**Architecture**
+----------------
+
+![](media/image2.png){width="6.267716535433071in"


There is no image under the Architecture header

RainyCodeWizard · 2021-04-01T01:17:50Z

docs/DeveloperGuide.md

+4.  Returning to main menu
+
+```{=html}
+<!-- -->


Consider removing the html comment tag.

iamakilahamed · 2021-04-01T01:18:25Z

docs/DeveloperGuide.md

+### User stories
+
+  **Priority**   **As a\...**   **I want to\...**                                       **So that I can\...**
+  -------------- -------------- ------------------------------------------------------- --------------------------------------------------
+  \* \* \*       new user       quickly refer to usage instructions                     quickly get on track with the workflow
+  \* \* \*       user           add a new staff/patient                                 
+  \* \* \*       user           delete staff/patients                                   remove entries i no longer need
+  \* \* \*       user           quickly look up schedules for both nurses and doctors   plan my schedule better
+  \* \* \*       user           quickly look up inventory inventories                        plan what and when to restock our inventory supplies
+  \*             user           have the program recognize slight errors in typing      have leeway working in a high-stress environment
+
+### 


It is to difficult to read this information. This could be due to formatting issues. Perhaps, adding "|" after each entry should help you solve this problem.
https://guides.github.com/features/mastering-markdown/

iamakilahamed · 2021-04-01T01:25:53Z

docs/DeveloperGuide.md

+Getting User Input
+
+> User input add command which is processed by DrugInstance.run().
+
+Creating Drug object with User Input
+
+> DrugAction.addDrug() creates a new NurseSchedule object and is stored
+> into an existing ArrayList\<Drug\> inventory which contains all the inventory
+> objects.
+


The information under this section could have been presented in a better format. Perhaps of using ">" to add details of the features, I think you can use bulleted points or numbers to break these information into different steps.

liping-eng · 2021-04-02T12:33:14Z

docs/DeveloperGuide.md

+**Architecture**
+----------------
+
+![](media/image2.png){width="6.267716535433071in"


There is no image here, possibly a rendering error?

liping-eng · 2021-04-02T12:37:11Z

docs/DeveloperGuide.md

+  \* \* \*       user           quickly look up inventory inventories                        plan what and when to restock our inventory supplies
+  \*             user           have the program recognize slight errors in typing      have leeway working in a high-stress environment
+
+### 


There seems to be an additional "###". It also appeared in a few other areas in the document, remember to remove it!

liping-eng · 2021-04-02T12:41:46Z

docs/DeveloperGuide.md

+
+### **Doctor Appointment-related Features**
+
+[Implementation:]{.ul}


There is a few instances of such notations, "[description:]{.ul}". Does the notation have any significance? It would be good to put mention what the notation means in the glossary!

liping-eng · 2021-04-02T12:50:27Z

docs/DeveloperGuide.md

+    > called in the classes stated below.
+
+[Actions:]{.ul}
+


Is this an example of an action or all method uses this action? Got a little confused here, would be good to elaborate what is this part for?

liping-eng · 2021-04-02T12:52:56Z

docs/DeveloperGuide.md

+[Actions:]{.ul}
+
+1.  In the menu of Doctor's Appointment, command of "add D12345 Alex M
+    > 21012021".


Is the design of using ">" intentional? I thought it was hard to read when the command is broken up. Do you think "> add D12345 Alex M 21012021" is better?

liping-eng · 2021-04-02T12:57:09Z

docs/DeveloperGuide.md

@@ -1,3 +1,1140 @@
+**Developer Guide**


The DG is well written with breakdown on architecture and implementation. I think the group can focus on improving the format of the information written. There seems to be an issue on the images as they were not rendered properly so I could not give comment on the use of visuals. Keep up the good work! Good Job :))

JonathanKhooTY · 2021-04-01T01:12:12Z

docs/DeveloperGuide.md

+app is for the head nurse of a hospital, if the user can type fast, it
+is better than a traditional GUI app.
+
+### **Purpose and scope**


Good section explaining the purpose and context of this DG.

JonathanKhooTY · 2021-04-01T01:14:07Z

docs/DeveloperGuide.md

+    > what actions to perform. The actions to be performed are methods
+    > called in the classes stated below.
+
+[Actions:]{.ul}


Having additional pictures will be good, as it is clearer for reader to understand

JonathanKhooTY · 2021-04-01T01:23:05Z

docs/DeveloperGuide.md

+6.  When the user types in a command,
+
+    a.  Duke.run() calls UI.scanInput() to read the user's input from
+        > the command line.


Usage of the "a." here seems confusing since the rest of the DG does not follow a similar format.

JonathanKhooTY · 2021-04-01T01:29:12Z

docs/DeveloperGuide.md

+
+3. deleteSchedule() loops through the arraylist of schedules and calls remove() to delete the specified schedule. 
+
+### **Doctor Appointment-related Features**


Consider utilising bullet points for this section. The formatting is rather confusing, when viewed on the site.

…into V2.1

V2.1 updated DA Java CI

Added proposed features section

…into V2.1

Update alexandertanjunan.md

V2.1 updated DA Java CI

Add design considerations to DG

add exception for storage

Changes in code

lyndseyBeil reviewed Mar 21, 2021

View reviewed changes

MingShun98 closed this Mar 21, 2021

okkhoy reopened this Mar 30, 2021

okkhoy changed the title ~~[CS2113-F08-2] HealthVault~~ [CS2113T-F08-2] HealthVault Mar 30, 2021

JethroPhuah reviewed Mar 31, 2021

View reviewed changes

ManikaHennedige reviewed Mar 31, 2021

View reviewed changes

lamzf1998 reviewed Mar 31, 2021

View reviewed changes

RainyCodeWizard suggested changes Apr 1, 2021

View reviewed changes

iamakilahamed reviewed Apr 1, 2021

View reviewed changes

liping-eng reviewed Apr 2, 2021

View reviewed changes

JonathanKhooTY reviewed Apr 5, 2021

View reviewed changes

LAPTOP-VRGPN0FU\MingS and others added 16 commits April 10, 2021 23:01

updated DA Java CI

84d236d

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-2/tp …

5dbc780

…into V2.1

Update DeveloperGuide.md

e9b6e6e

Merge pull request #362 from MingShun98/V2.1

5efb2ba

V2.1 updated DA Java CI

Create StaffAddSD.puml

a4a7333

Merge pull request #364 from AlexanderTanJunAn/master

c9c844a

Added proposed features section

Add files via upload

e35f79b

StaffAddSD

6038232

Update alexandertanjunan.md

a4a5743

updated DA Java CI

aa13a20

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-2/tp …

e03719a

…into V2.1

Merge pull request #365 from AlexanderTanJunAn/master

f48b9eb

Update alexandertanjunan.md

Merge pull request #366 from MingShun98/V2.1

45a7d32

V2.1 updated DA Java CI

add design considerations to DG

911273c

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-2/tp

7d44c60

Merge pull request #367 from Chiamjiaen/master

8b8f302

Add design considerations to DG

Chiamjiaen and others added 30 commits April 12, 2021 21:47

UG finalization update

77c7ea0

fixed typos

3be1f0e

Updated bugs

29b6bc0

updated image for Inventorylist

ed810be

Minor changes

9c7508d

hehe xd

9d7b9c5

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-2/tp

ccc8c71

fixed UG bug

675c848

Set theme jekyll-theme-slate

0dca30e

add some exception handling

fd1d50c

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-2/tp

89d7454

Merge pull request #425 from Chiamjiaen/master

39e111e

add exception for storage

Update _config.yml

3e0d823

Set theme jekyll-theme-cayman

b9d747e

Set theme jekyll-theme-cayman

d41fc93

Changes in code

55f2c64

Merge pull request #426 from NoorSarrah/codeChanges

0312b8c

Changes in code

Update DeveloperGuide.md

41ffe2a

Update AboutUs.md

4a0dc4f

Update DeveloperGuide.md

26e36e5

Update DeveloperGuide.md

ed4815b

Update DeveloperGuide.md

9367b08

Update DeveloperGuide.md

07720aa

Update DeveloperGuide.md

29f7a29

Update DeveloperGuide.md

51b78ab

Update DeveloperGuide.md

d5ed962

Update DeveloperGuide.md

0bdfec2

Update DeveloperGuide.md

d800a43

Update DeveloperGuide.md

2673c6e

Update DeveloperGuide.md

1355aa3


		import seedu.duke.exceptions.DukeException;

		public class duplicateIDException extends DukeException {


		add \[Staff ID\] \[name\] \[age\] \[specialisation\]

		> Getting User Input


		### Doctor Appointment-related Features

		[Implementation:]{.ul}


		3. deleteSchedule() loops through the arraylist of schedules and calls remove() to delete the specified schedule.

		### Doctor Appointment-related Features

[CS2113T-F08-2] HealthVault #12

Are you sure you want to change the base?

[CS2113T-F08-2] HealthVault #12

Conversation

MingShun98 commented Mar 3, 2021

MingShun98 commented Mar 3, 2021

Choose a reason for hiding this comment

okkhoy commented Mar 30, 2021

JethroPhuah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RainyCodeWizard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iamakilahamed Apr 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iamakilahamed Apr 1, 2021 •

edited

Loading