Merge pull request nus-cs2103-AY2324S1#207 from jx124/jx-update-dg

Update documentation -- Jie Xiang
yuxunn · Nov 13, 2023 · 3d46458 · 3d46458
2 parents 44b01cd + 29bf8d9
commit 3d46458
Show file tree

Hide file tree

Showing 20 changed files with 308 additions and 110 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -43,12 +43,15 @@ D.A.V.E. is here to enhance your advisory journey by simplifying information man
 
 Here are some descriptions of the words we use throughout the User Guide:
 
-| Term    | Definition                                                                                            |
-|---------|-------------------------------------------------------------------------------------------------------|
-| Command | An input from the user that tells D.A.V.E. to perform an action (e.g. add a client).                  |
-| GUI     | Graphical User Interface (GUI) refers to the visual display of D.A.V.E that users can see.            |
-| CLI     | Command Line Interface (CLI) represents a text-based user interface to interact with the application. |
-| Person  | A client or a lead.                                                                                   |
+| Term          | Definition                                                                                            |
+|---------------|-------------------------------------------------------------------------------------------------------|
+| Command       | An input from the user that tells D.A.V.E. to perform an action (e.g. add a client).                  |
+| GUI           | Graphical User Interface (GUI) refers to the visual display of D.A.V.E that users can see.            |
+| CLI           | Command Line Interface (CLI) represents a text-based user interface to interact with the application. |
+| Client        | A customer of the financial advisor.                                                                  |
+| Lead          | A contact who is deemed a potential customer.                                                         |
+| Person        | A client or a lead.                                                                                   |
+| Key Milestone | A date of significant importance for a lead, e.g. date of graduation.                                 |
 
 # Quick Start
 

diff --git a/docs/diagrams/AddClientSequenceDiagram.png b/docs/diagrams/AddClientSequenceDiagram.png
diff --git a/docs/diagrams/AddClientSequenceDiagram.puml b/docs/diagrams/AddClientSequenceDiagram.puml
@@ -5,27 +5,44 @@ skinparam ArrowFontStyle plain
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
-participant "u:ListClientCommand" as ListClientCommand LOGIC_COLOR
+participant ":AddClientCommandParser" as AddClientCommandParser LOGIC_COLOR
+participant "a:AddClientCommand" as AddClientCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 participant ":AddressBook" as AddressBook MODEL_COLOR
 end box
-[-> LogicManager : execute(listclient n/...)
+[-> LogicManager : execute("addclient n/...")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand(listclient n/...)
+LogicManager -> AddressBookParser : parseCommand("addclient n/...")
 activate AddressBookParser
 
+create AddClientCommandParser
+AddressBookParser -> AddClientCommandParser
+activate AddClientCommandParser
+
+AddClientCommandParser --> AddressBookParser
+deactivate AddClientCommandParser
+
+AddressBookParser -> AddClientCommandParser : parse("n/...")
+activate AddClientCommandParser
+
 create AddClientCommand
-AddressBookParser -> AddClientCommand
+AddClientCommandParser -> AddClientCommand
 activate AddClientCommand
 
-AddClientCommand --> AddressBookParser
+AddClientCommand --> AddClientCommandParser : a
 deactivate AddClientCommand
 
-AddressBookParser --> LogicManager : return something
+AddClientCommandParser --> AddressBookParser : a
+deactivate AddClientCommandParser
+AddClientCommandParser -[hidden]-> AddressBookParser : a
+destroy AddClientCommandParser
+
+AddressBookParser --> LogicManager : a
 deactivate AddressBookParser
 
 LogicManager -> AddClientCommand : execute()
@@ -37,13 +54,21 @@ activate Model
 Model -> AddressBook : addClient()
 activate AddressBook
 
+AddressBook --> Model
+deactivate AddressBook
+
 Model --> AddClientCommand
 deactivate Model
 
+create CommandResult
+AddClientCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> AddClientCommand
+deactivate CommandResult
+
 AddClientCommand --> LogicManager : result
 deactivate AddClientCommand
-AddClientCommand -[hidden]-> LogicManager : result
-destroy AddClientCommand
 
 [<--LogicManager
 deactivate LogicManager

diff --git a/docs/diagrams/AddMeetingTimeSequenceDiagram.png b/docs/diagrams/AddMeetingTimeSequenceDiagram.png
diff --git a/docs/diagrams/AddMeetingTimeSequenceDiagram.puml b/docs/diagrams/AddMeetingTimeSequenceDiagram.puml
@@ -5,51 +5,84 @@ skinparam ArrowFontStyle plain
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
-participant "u:AddMeetingCommand" as AddMeetingCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+participant ":AddMeetingCommandParser" as AddMeetingCommandParser LOGIC_COLOR
+participant "a:AddMeetingCommand" as AddMeetingCommand LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 participant "personWithMeetingAdded:Person" as Person MODEL_COLOR
 end box
 
-[-> LogicManager : execute(addmeeting ...)
+[-> LogicManager : execute("addmeeting 1 m/...")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand(addmeeting ...)
+LogicManager -> AddressBookParser : parseCommand("addmeeting 1 m/...")
 activate AddressBookParser
 
+create AddMeetingCommandParser
+AddressBookParser -> AddMeetingCommandParser
+activate AddMeetingCommandParser
+
+AddMeetingCommandParser --> AddressBookParser
+deactivate AddMeetingCommandParser
+
+AddressBookParser -> AddMeetingCommandParser : parse("1 m/...")
+activate AddMeetingCommandParser
+
 create AddMeetingCommand
-AddressBookParser -> AddMeetingCommand
+AddMeetingCommandParser -> AddMeetingCommand
 activate AddMeetingCommand
 
-AddMeetingCommand --> AddressBookParser
+AddMeetingCommand --> AddMeetingCommandParser : a
 deactivate AddMeetingCommand
 
-AddressBookParser --> LogicManager : u
+AddMeetingCommandParser --> AddressBookParser : a
+deactivate AddMeetingCommandParser
+AddMeetingCommandParser -[hidden]-> AddressBookParser : a
+destroy AddMeetingCommandParser
+
+AddressBookParser --> LogicManager : a
 deactivate AddressBookParser
 
 LogicManager -> AddMeetingCommand : execute()
 activate AddMeetingCommand
 
+AddMeetingCommand -> Model : getFilteredPersonList()
+activate Model
+
+Model --> AddMeetingCommand
+deactivate Model
+
 create Person
 AddMeetingCommand -> Person
 activate Person
+
 Person --> AddMeetingCommand
 deactivate Person
 
 AddMeetingCommand -> Model : setPerson(personToAddMeeting, personWithMeetingAdded)
 activate Model
 
+Model --> AddMeetingCommand
+deactivate Model
+
+AddMeetingCommand -> Model : updateFilteredPersonList()
+activate Model
 
 Model --> AddMeetingCommand
 deactivate Model
 
+create CommandResult
+AddMeetingCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> AddMeetingCommand : result
+deactivate CommandResult
 
 AddMeetingCommand --> LogicManager : result
 deactivate AddMeetingCommand
-AddMeetingCommand -[hidden]-> LogicManager : result
-destroy AddMeetingCommand
 
 [<--LogicManager
 deactivate LogicManager

diff --git a/docs/diagrams/ConvertLeadToClientSequence.png b/docs/diagrams/ConvertLeadToClientSequence.png
diff --git a/docs/diagrams/ConvertLeadToClientSequence.puml b/docs/diagrams/ConvertLeadToClientSequence.puml
@@ -6,40 +6,81 @@ box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":ConvertLeadToClientCommandParser" as ConvertLeadToClientCommandParser LOGIC_COLOR
-participant ":ConvertLeadToClientCommand" as ConvertLeadToClientCommand LOGIC_COLOR
+participant "c:ConvertLeadToClientCommand" as ConvertLeadToClientCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
+participant "convertedLead:Person" as Person MODEL_COLOR
 end box
 
-[-> LogicManager : execute(converttoclient <Integer>)
+[-> LogicManager : execute("converttoclient 1")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand(converttoclient <Integer>)
+LogicManager -> AddressBookParser : parseCommand("converttoclient 1")
 activate AddressBookParser
 
-AddressBookParser --> LogicManager
-deactivate AddressBookParser
+create ConvertLeadToClientCommandParser
+AddressBookParser -> ConvertLeadToClientCommandParser
+activate ConvertLeadToClientCommandParser
 
+ConvertLeadToClientCommandParser --> AddressBookParser
+deactivate
 
-AddressBookParser -> ConvertLeadToClientCommandParser : parse(converttoclient <Integer>)
+AddressBookParser -> ConvertLeadToClientCommandParser : parse("1")
 activate ConvertLeadToClientCommandParser
 
 create ConvertLeadToClientCommand
 ConvertLeadToClientCommandParser -> ConvertLeadToClientCommand
 activate ConvertLeadToClientCommand
 
+ConvertLeadToClientCommand --> ConvertLeadToClientCommandParser : c
+deactivate ConvertLeadToClientCommand
+
+ConvertLeadToClientCommandParser --> AddressBookParser : c
+deactivate
+ConvertLeadToClientCommandParser -[hidden]-> AddressBookParser : c
+destroy ConvertLeadToClientCommandParser
+
+AddressBookParser --> LogicManager : c
+deactivate AddressBookParser
+
+LogicManager -> ConvertLeadToClientCommand : execute()
+activate ConvertLeadToClientCommand
+
 ConvertLeadToClientCommand -> Model : getFilteredPersonList()
 activate Model
 
 Model --> ConvertLeadToClientCommand : List of Persons
-ConvertLeadToClientCommand -> Model : setPerson()
-ConvertLeadToClientCommand -> Model : updateFilterPredicate()
 deactivate Model
 
-ConvertLeadToClientCommand --> LogicManager : CommandResult
+create Person
+ConvertLeadToClientCommand -> Person
+activate Person
+
+Person --> ConvertLeadToClientCommand
+deactivate
+
+ConvertLeadToClientCommand -> Model : setPerson(personToConvert, convertedLead)
+activate Model
+Model --> ConvertLeadToClientCommand
+deactivate Model
+
+ConvertLeadToClientCommand -> Model : updateFilteredPersonList()
+activate Model
+Model --> ConvertLeadToClientCommand
+deactivate Model
+
+create CommandResult
+ConvertLeadToClientCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> ConvertLeadToClientCommand : result
+deactivate CommandResult
+
+ConvertLeadToClientCommand --> LogicManager : result
 deactivate ConvertLeadToClientCommand
 deactivate ConvertLeadToClientCommandParser
 deactivate AddressBookParser

diff --git a/docs/diagrams/ListClientCommandSequence.png b/docs/diagrams/ListClientCommandSequence.png
diff --git a/docs/diagrams/ListClientCommandSequence.puml b/docs/diagrams/ListClientCommandSequence.puml
@@ -6,34 +6,48 @@ box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant "u:ListClientCommand" as ListClientCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 end box
 
-[-> LogicManager : execute(listclient)
+[-> LogicManager : execute("listclient")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand(listclient)
+LogicManager -> AddressBookParser : parseCommand("listclient")
 activate AddressBookParser
 
-AddressBookParser --> LogicManager
-deactivate AddressBookParser
 
 create ListClientCommand
-AddressBookParser -> ListClientCommand : execute()
+AddressBookParser -> ListClientCommand
 activate ListClientCommand
 
-ListClientCommand -> Model : updateFilterPredicate()
+ListClientCommand --> AddressBookParser : u
+deactivate ListClientCommand
+
+AddressBookParser --> LogicManager : u
+deactivate AddressBookParser
+
+LogicManager -> ListClientCommand : execute()
+activate ListClientCommand
+
+ListClientCommand -> Model : updateFilteredPersonList()
 activate Model
 
 Model --> ListClientCommand
 deactivate Model
 
+create CommandResult
+ListClientCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> ListClientCommand : result
+deactivate
+
 ListClientCommand --> LogicManager : result
 deactivate ListClientCommand
-destroy ListClientCommand
 
 [<--LogicManager
 deactivate LogicManager

diff --git a/docs/diagrams/ModelClassDiagram.png b/docs/diagrams/ModelClassDiagram.png
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -21,6 +21,9 @@ Class Type
 Class Name
 Class Phone
 Class Tag
+Class MeetingTime
+Class MeetingTimeFormatter
+Class PersonMeetingTimeComparator
 
 Class I #FFFFFF
 }
@@ -44,6 +47,7 @@ Person *--> Phone
 Person *--> Email
 Person *--> Type
 Person *--> Address
+Person *--> "0..1" MeetingTime
 Person *--> "*" Tag
 
 Person -[hidden]up--> I
@@ -53,5 +57,8 @@ Name -[hidden]right-> Phone
 Phone -[hidden]right-> Address
 Address -[hidden]right-> Email
 
-ModelManager --> "~* filtered" Person
+ModelManager --> "~* filtered and sorted" Person
+ModelManager ..> PersonMeetingTimeComparator
+UserPrefs .[hidden].> PersonMeetingTimeComparator
+MeetingTime ..> MeetingTimeFormatter
 @enduml
diff --git a/docs/diagrams/PersonClassDiagram.png b/docs/diagrams/PersonClassDiagram.png
diff --git a/docs/diagrams/PersonClassDiagram.puml b/docs/diagrams/PersonClassDiagram.puml
@@ -8,10 +8,13 @@ Package "Person Classes" as ModelPackage <<Rectangle>>{
 Class "{abstract}\nPerson" as Person
 Class Lead
 Class Client
+Class KeyMilestone
 }
 Class HiddenOutside #FFFFFF
 HiddenOutside ..> Person
 
 Lead -up-|> Person
 Client -up-|> Person
+
+Lead *--> KeyMilestone
 @enduml
diff --git a/docs/diagrams/SortMeetingTimeSequenceDiagram.png b/docs/diagrams/SortMeetingTimeSequenceDiagram.png