[CS2113T-T09-3] HalpMi #3

tanweili · 2022-03-03T01:19:05Z

The hospital management system is a CLI application that helps to manage all hospital data with ease and efficiency where the user is the hospital administrator.

Add UML for Med and Appt classes

# Conflicts: # docs/DeveloperGuide.md

Correcting Format Issues present in DG

DG linking png images

GlendonNotGlen

Great implementation of DG overall. The DG was easy to read and diagrams are very neat without being overly cluttered.

GlendonNotGlen · 2022-03-31T02:08:36Z

docs/DeveloperGuide.md

 ## Glossary
+* *FUllNAME* - Standard form for fullname of patients and doctors is a String value with no spaces
+* *NRIC* - Standard form for nric of patients and doctors is a String value with no spaces
+* *AGE* - Standard form for age is an int value more than 0
+* *GENDER* - Standard form for gender of patients and doctors is a char value of "M" or "F"
+* *ADDRESS* - Standard form for address is a String value with no spaces
+* *DOB* - Standard form for date-of-birth is a String value with no spaces
+* *SPECIALIZATION* - Standard form for specialization of doctors is String value with no spaces
+* *MEDICINEID* - Standard form for medicine id is a String value with no spaces
+* *MEDICINENAME* - Standard form for medicine name is a String value with no spaces
+* *DOSAGE* - Standard form for dosage of medicine is an int value, standard unit milligrams
+* *EXPIRY* - Standard form for expiry of medicine is a String value with no spaces
+* *SIDEEFFECTS* - Standard form for side effects of medicine is a String value with no spaces
+* *QUANTITY* - Standard form for quantity of medicine is an int value
+* *APPOINTMENTID* - Standard form for appointment id is a String value with no spaces
+* *APPOINTMENTDETAILS* - Standard form for appointment details is a String value


Great use of a glossary here! Really helps in understanding the DG better

GlendonNotGlen · 2022-03-31T02:10:29Z

docs/DeveloperGuide.md

+
+The rest of the App consists of these components.
+
+* [**`Manager`**](#manager-component): The Brain.


Not sure if calling The Brain would be appropriate? Can perhaps change it to main driver function or say 'where most of the logic is computed'?

GlendonNotGlen · 2022-03-31T02:11:11Z

docs/DeveloperGuide.md

+
+### Architecture
+
+![Architecture Diagram](diagrams/OverallArch.png)


Really great diagram that gives an overall architecture overview of your program

GlendonNotGlen · 2022-03-31T02:16:00Z

docs/DeveloperGuide.md


-## User Stories
+Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`


I think the formatting of this legend can be neater? Overall great idea nonetheless!

GlendonNotGlen · 2022-03-31T02:18:03Z

docs/DeveloperGuide.md

+### Non-Functional Requirements
+Device Environment:
+* Must have Java 11 or higher installed in OS
+* 32-bit or 64-bit environment
+* Command Line Interface supported
+
+  Performance of app:
+* Function offline, without the need for internet access
+* Quick to launch and use
+* No noticeable lag or delay in performance when running
+* Intuitive and seamless for new users.
+* Ability to export the data into a txt file to load on another OS
+
+  Reliability of app:
+* Data files should be updated constantly and accurately, with no data loss
+* Data records should be retrievable and readable
+* Text inputs should produce similar results if utilised multiple times.
+* Program should run without any forced-close error due to bugs
+--------------------------------------------------------------------------------------------------------------------


Do becareful of formatting error. The sub headers here seem to be misaligned

Ch40gRv1-Mu

Some diagrams are too complex and hard to read for reader. May suggest to hide some details. For example, there's no need to show all the methods of classes in the Class diagram? (Can use notation to inform you hide some unimportant methods instead)

Ch40gRv1-Mu · 2022-03-31T02:15:10Z

docs/DeveloperGuide.md

+![Architecture Diagram](diagrams/OverallArch.png)
+


Why is there a component named Duke in the overall architecture while your product name is not Duke. Do you mean the main function?

Ch40gRv1-Mu · 2022-03-31T02:15:55Z

docs/DeveloperGuide.md

+**`Duke`** has single method called `main` which is called upon launch. This initialises a new instance of a `Manager` class, and calls the `runLoop()`
+method belonging to the Manager object.


Suggests to change the name of "Duke" to "Main" instead to avoid confuseness.

Ch40gRv1-Mu · 2022-03-31T02:17:01Z

docs/DeveloperGuide.md

+
+The rest of the App consists of these components.
+
+* [**`Manager`**](#manager-component): The Brain.


Confusing expression. Explain what does this component do specific instead.

Ch40gRv1-Mu · 2022-03-31T02:18:43Z

docs/DeveloperGuide.md

+    * [**`Command`**](#command): Contains the changes or updates to be made.
+    * [**`UI`**](#ui-component): The UI of the App.
+    * [**`Parser`**](#parser): Breaks down user input into parameters accepted by the app and creates a Command Object.
+    * [**`Validator`**](): Checks if the input provided by the User is Valid.
+    * [**`Storage`**](#storage): Reads data from data files and writes data to data files, also stores in app memory.
+


Is this correct indentation? or Command, UI, Parser, Validator, Storage belongs to Helper? which does not make sense

Ch40gRv1-Mu · 2022-03-31T02:21:03Z

docs/DeveloperGuide.md

+Currently, `AppointmentList` has the following methods:
+* `AppointmentList#add` -- Appends a new `Appointment` to the list.
+* `AppointmentList#remove` -- Removes an entry from the list by appointment id.
+* `AppointmentList#edit` -- Edits a existing entry from the list by.
+* `AppointmentList#view` -- Text display of all or selected appointments in the list.
+* `AppointmentList#find` -- Find selected appointments using the criteria given.


May hide some unimportant detail but only state the noteworthy part instead.

Ch40gRv1-Mu · 2022-03-31T02:28:49Z

docs/diagrams/CommandUML.puml

+@startuml
+'https://plantuml.com/sequence-diagram
+
+alt add patient
+    Manager -> Command: addPatient
+    Command -> PatientList: add
+else delete patient
+    Manager -> Command: deletePatient


Suggest to add a notation to declare that this is a minimum notation sequence diagram.

Ch40gRv1-Mu · 2022-03-31T02:30:53Z

docs/diagrams/SequenceDiagram.puml

+Duke -> Manager : Manager()
+activate Manager


Is this wrong notation for execution of constructor? The activation bar should jus under the class. You may miss "create Manager"

Ch40gRv1-Mu · 2022-03-31T02:31:11Z

docs/diagrams/SequenceDiagram.puml

+Manager -> UI: UI()
+activate UI
+UI --> Manager


Same as the previous comments

Ch40gRv1-Mu · 2022-03-31T02:31:42Z

docs/diagrams/SequenceDiagram.puml

+destroy Storage
+destroy UI
+destroy Parser
+destroy Validator
+destroy Manager
+deactivate Duke
+destroy Duke
+


So review all the execution of construction pls.

Ch40gRv1-Mu · 2022-03-31T02:33:26Z

docs/diagrams/StorageClassUML.puml

+List <|-- PatientList
+List <|-- DoctorList
+List <|-- MedicineList
+List <|-- AppointmentList


The arrows are too messy. Moreover, I didn't see the value to express the association between Storage and all specific XYZList, which doesn't add value. Can just show the a specific case as example

limjierui · 2022-03-31T02:21:57Z

docs/diagrams/SequenceDiagram.puml

+deactivate Duke
+destroy Duke
+
+@enduml


Understand that there are many method calls in this sequence diagram, however the sequence diagram looks like there is alot going on. Perhaps it would be better to break it down into separate sequence diagrams and reference each other.

limjierui · 2022-03-31T02:25:44Z

docs/diagrams/ValidatorClassUML.puml

+-validateQuantity(String): boolean
+-validateSpecialization(String): void
+}
+@enduml


This class seem to contain alot of methods and attributes, and it looks lengthy. Perhaps it be better to include only important attributes and methods.

limjierui · 2022-03-31T02:34:35Z

docs/diagrams/CommandUML.puml

+    Manager -> Command: viewMedicine
+    Command -> MedicineList: viewMedicine
+end
+@enduml


Would any of the commands return any output or list? If it does, will be good to show a return arrow back to the main class that calls the commands.

limjierui · 2022-03-31T02:35:47Z

docs/diagrams/ParserClassUML.puml

+parseViewMedicine(String): Command
+parseViewPatient(String): Command
+}
+@enduml


Again, there seems to be too many methods displayed in this function, perhaps it will be better to reduce and display only important methods and attributes.

ngys117

Mostly seems fine. Just need to take note of static members/methods in class diagrams. Another comment is maybe consider following the lecture uml diagram notation for showing visibility and abstract classes.

ngys117 · 2022-03-31T02:11:07Z

docs/DeveloperGuide.md

+
+The rest of the App consists of these components.
+
+* [**`Manager`**](#manager-component): The Brain.


I'm not sure if this description is helpful. Maybe be a bit more explicit with what the Manager actually does? From the diagram it seems like it acts as an intermediary between the User/Duke and the rest of the components.

ngys117 · 2022-03-31T02:13:31Z

docs/DeveloperGuide.md

+
+#### `Validator`
+
+![ValidatorClassUML](diagrams/ValidatorClassUML.png)


Perhaps the color is too dark, making the black text hard to read.

ngys117 · 2022-03-31T02:15:57Z

docs/DeveloperGuide.md

+
+#### `Storage`
+
+![StorageClassUML](diagrams/StorageClassUML.png)


Maybe there are too many inheritance arrowheads and association arrows overlapping one another?

Consider changing the formatting so that the either the Storage or List class is at the bottom to remove the overlaps.

ngys117 · 2022-03-31T02:18:19Z

docs/DeveloperGuide.md


-{Describe the target user profile}
+###Target user profile:


Seems like the header formatting is showing in the actual webpage?

ngys117 · 2022-03-31T02:21:36Z

docs/DeveloperGuide.md

+* prefers typing to mouse interactions
+* is reasonably comfortable using CLI apps
+
+###Value proposition:


Same issue with header formatting here.

ngys117 · 2022-03-31T02:22:53Z

docs/DeveloperGuide.md

+  Performance of app:
+* Function offline, without the need for internet access
+* Quick to launch and use
+* No noticeable lag or delay in performance when running
+* Intuitive and seamless for new users.
+* Ability to export the data into a txt file to load on another OS
+
+  Reliability of app:
+* Data files should be updated constantly and accurately, with no data loss
+* Data records should be retrievable and readable
+* Text inputs should produce similar results if utilised multiple times.
+* Program should run without any forced-close error due to bugs
+--------------------------------------------------------------------------------------------------------------------


Are the indentations for "Performance of app" and "Reliability of app" here intentional? Looks inconsistent with the "Device Environment" portion.

ngys117 · 2022-03-31T02:26:20Z

docs/DeveloperGuide.md

+
+The Sequence Diagram below showcases the general Logic and Flow of the program from Launch till Exit.
+
+![Sequence Diagram](diagrams/SequenceDiagram.png)


Not sure if the sequence diagram should have additional objects at the footing.

ngys117 · 2022-03-31T02:30:52Z

docs/DeveloperGuide.md

+
+#### `Parser`
+
+![ParserClassUML](diagrams/ParserClassUML.png)


It seems like the parser methods are static. Perhaps they should be underlined in the class diagram?

ngys117 · 2022-03-31T02:36:21Z

docs/DeveloperGuide.md

+For example, validateAddPatient validates the parameter of `add patient` command, ensuring each parameter is in correct
+format. Please refer to the below sequence diagram for a clearer understanding.
+
+![ValidatorUML](diagrams/ValidatorUML.png)


It seems like the validator methods are static as well. Perhaps they should be underlined in the class diagram?

ngys117 · 2022-03-31T02:41:03Z

docs/DeveloperGuide.md

+
+### UI component
+
+![UIClassUML](diagrams/UIClassUML.png)


Consider following the lecture uml diagram notation for showing visibility and abstract classes.

FaliciaOng

The developer guide was fairly clear. Good job!

FaliciaOng · 2022-03-31T03:36:10Z

docs/DeveloperGuide.md

+
+The Sequence Diagram below showcases the general Logic and Flow of the program from Launch till Exit.
+
+![Sequence Diagram](diagrams/SequenceDiagram.png)


Is this format correct? Should the lifeline stop after the deletion of an object?

FaliciaOng · 2022-03-31T03:42:06Z

docs/DeveloperGuide.md

+For example, validateAddPatient validates the parameter of `add patient` command, ensuring each parameter is in correct
+format. Please refer to the below sequence diagram for a clearer understanding.
+
+![ValidatorUML](diagrams/ValidatorUML.png)


Should there be a self-invocation bar for each calling of own method?

Changing saveString() method for patient and doctor

IdGenerator has a static method to generator a pseudo unique ID which is a 8 digit number in String format. Can be used for other lists as well. Still in the midst of changing the add appt cmd. Currently, it should check if patient and doctor exists. However, still need to implement adding into the appointment list.

In order to retrieve info regarding patient and doctor names to simplify add appt command, apptList needs to know about patients and doctors.

IdGenerator now has a method that is specific to add appt. New add appt generates a pseudo unique hash from patient and doctor nric and appt date.

So that appt data is correctly loaded upon start up.

Made error message for name error to be more explicit in rejecting special characters and numbers.

Made error message for invalid age input to be more explicit in referring to the age parameter.

Update UG DG to reflect the change that view doctor can now view by specific criteria.

Update UG DG to reflect changes to find patient being able to search by criteria.

Update UG DG to reflect changes to view medicine feature.

Final checks

Fix appointment bugs

Fixing issue with loading data of older date

* 'master' of https://github.com/AY2122S2-CS2113T-T09-3/tp: Fixing issue with loading data of older date Update wraineflores.md Inserting image into About Us Removing edit apppointment function and fixing delete appointment bugs Update wraineflores.md Update wraineflores.md add screenshots for all functions remove edit appointment Update pt ptList appt apptList UML Diag to reflect new methods added update UG with screenshot for add add pics for add function UG Reduce size of Manager UML image Update appt and apptList UML images to reflect new methods add line break crop picture fix findpatient exit error help-change add findappointment screenshot # Conflicts: # docs/UserGuide.md

…into UG-update-changes * 'master' of https://github.com/AY2122S2-CS2113T-T09-3/tp: Fixing issue with loading data of older date

* master: # Conflicts: # docs/UserGuide.md

add missing images

Wei li fix ug

Add sharif photo in and one more UG section hyperlink

Hopefully this IS the final changes

Change DOA to DOR in UG

Age must corresponse with birthdate and in this case should be 22

shxr3f and others added 8 commits March 30, 2022 21:34

Merge pull request #132 from tanweili/WeiLi-UpdateDG_UML

85653d6

Add UML for Med and Appt classes

Making corrections to format

f9c8e71

Merge branch 'master' into branch-DG_Corrections

abc2adf

# Conflicts: # docs/DeveloperGuide.md

More changes to formatting

0e06254

Adding full stops.

9d8559e

Merge pull request #135 from shxr3f/branch-DG_Corrections

a5dd3ea

Correcting Format Issues present in DG

DG linking png images

41f9b68

Merge pull request #136 from wraineflores/wraineflores-update-v3

a5ad229

DG linking png images

GlendonNotGlen reviewed Mar 31, 2022

View reviewed changes

tanweili changed the title ~~[CS2113T-T09-3] Hospital Management System~~ [CS2113T-T09-3] HalpMi Mar 31, 2022

Ch40gRv1-Mu reviewed Mar 31, 2022

View reviewed changes

limjierui reviewed Mar 31, 2022

View reviewed changes

ngys117 reviewed Mar 31, 2022

View reviewed changes

FaliciaOng reviewed Mar 31, 2022

View reviewed changes

shxr3f and others added 16 commits March 31, 2022 18:27

Changing saveString() method for patient and doctor

136af72

Merge pull request #137 from shxr3f/branch-correctBugs

78bed26

Changing saveString() method for patient and doctor

Implement reference from ApptList to PatientList and DtrList

352704c

In order to retrieve info regarding patient and doctor names to simplify add appt command, apptList needs to know about patients and doctors.

Update IdGenerator and implement new add appointment

ed14d57

IdGenerator now has a method that is specific to add appt. New add appt generates a pseudo unique hash from patient and doctor nric and appt date.

Update appt saveString

4d15700

So that appt data is correctly loaded upon start up.

Update U/DG to reflect changes made to ApptList

7fccb48

Fix #138

28e5fc7

Made error message for name error to be more explicit in rejecting special characters and numbers.

Fix #139

761dc35

Made error message for invalid age input to be more explicit in referring to the age parameter.

Fix #141

8c4a0b6

Update UG DG to reflect the change that view doctor can now view by specific criteria.

Fix #143

71d97fe

Update UG DG to reflect changes to find patient being able to search by criteria.

Fix #148

a0bc724

Update UG DG to reflect changes to view medicine feature.

Fix Example documentation for Find commands

92e8087

Fix view appointment examples in user guide

2084dcb

Fix command to exit the application not documented and add help fucntion

26407d6

Fix command summary to include edit function

f05929b

Anvitha-r and others added 30 commits April 11, 2022 19:05

reverse changes made

eac06d3

Merge pull request #204 from kktai1512/final-checks

f80ee57

Final checks

delete the edit appointment image

0865a5d

Removing edit apppointment function and fixing delete appointment bugs

7dea58a

Merge branch 'master' into branch-fixAppointmentBugs

50411fa

Inserting image into About Us

79ece2f

Merge pull request #207 from shxr3f/branch-fixAppointmentBugs

c0be0fa

Fix appointment bugs

add photo to about us

ba2e266

Update wraineflores.md

a452e2b

fix the about us

c24ea02

update ppp

7e06b26

Merge branch 'master' into UG-update-changes

3663881

Fixing issue with loading data of older date

478de6a

Merge pull request #208 from shxr3f/branch-fixStorageBugs

2fe9975

Fixing issue with loading data of older date

Merge branch 'master' of https://github.com/AY2122S2-CS2113T-T09-3/tp …

f8890bb

…into UG-update-changes * 'master' of https://github.com/AY2122S2-CS2113T-T09-3/tp: Fixing issue with loading data of older date

Merge branch 'master' into UG-update-changes

96c6a47

* master: # Conflicts: # docs/UserGuide.md

update ug with screenshot

6b6d116

fix checkstyle

a454622

Merge pull request #206 from Anvitha-r/UG-update-changes

8b71c6e

add missing images

Merge branch 'AY2122S2-CS2113T-T09-3:master' into master

a6afb1b

Fix UG find section don't have hyperlink and remove some sections

6fa333f

Merge pull request #209 from tanweili/WeiLi-FixUG

98f7241

Wei li fix ug

Add sharif photo in and one more UG section hyperlink

8ee5836

Merge pull request #210 from tanweili/WeiLi-FixUG

4c75b59

Add sharif photo in and one more UG section hyperlink

Hopefully this IS the final changes

ade59bc

Merge pull request #211 from tanweili/WeiLiFFFFixes

0891496

Hopefully this IS the final changes

Change DOA to DOR in UG

f4f49c9

Merge pull request #212 from tanweili/WeiLi-ChangeDOAtoDOR

c876874

Change DOA to DOR in UG

Update cmd summary add patient & doctor example ages

063b6fa

Age must corresponse with birthdate and in this case should be 22


		The rest of the App consists of these components.

		* [`Manager`](#manager-component): The Brain.


		### Architecture

		![Architecture Diagram](diagrams/OverallArch.png)


		## User Stories
		Priorities: High (must have) - `* * `, Medium (nice to have) - ` `, Low (unlikely to have) - ``

		`Duke` has single method called `main` which is called upon launch. This initialises a new instance of a `Manager` class, and calls the `runLoop()`
		method belonging to the Manager object.


		#### `Validator`

		![ValidatorClassUML](diagrams/ValidatorClassUML.png)


		#### `Storage`

		![StorageClassUML](diagrams/StorageClassUML.png)


		The Sequence Diagram below showcases the general Logic and Flow of the program from Launch till Exit.

		![Sequence Diagram](diagrams/SequenceDiagram.png)

[CS2113T-T09-3] HalpMi #3

Are you sure you want to change the base?

[CS2113T-T09-3] HalpMi #3

Conversation

tanweili commented Mar 3, 2022

GlendonNotGlen 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

Ch40gRv1-Mu 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

Ch40gRv1-Mu Mar 31, 2022 • 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

ngys117 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ngys117 Mar 31, 2022 • edited Loading

Choose a reason for hiding this comment

ngys117 Mar 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ngys117 Mar 31, 2022 • 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

FaliciaOng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ch40gRv1-Mu Mar 31, 2022 •

edited

Loading

ngys117 Mar 31, 2022 •

edited

Loading

ngys117 Mar 31, 2022 •

edited

Loading

ngys117 Mar 31, 2022 •

edited

Loading