Skip to content

Commit

Permalink
Merge pull request #1 from AY1920S1-CS2103T-F12-2/master
Browse files Browse the repository at this point in the history
chore: sync with team repo
  • Loading branch information
Q-gabe authored Oct 6, 2019
2 parents b6a3518 + f2504ec commit c329609
Show file tree
Hide file tree
Showing 18 changed files with 426 additions and 63 deletions.
29 changes: 13 additions & 16 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
= Address Book (Level 3)
= VISIT: Patient Tracker for Doctors On-The-Go
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
https://travis-ci.org/AY1920S1-CS2103T-F12-2/main[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
https://coveralls.io/github/AY1920S1-CS2103T-F12-2/main?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]


ifdef::env-github[]
image::docs/images/Ui.png[width="600"]
image::docs/images/Ui.png[width="900"]
endif::[]

ifndef::env-github[]
image::images/Ui.png[width="600"]
image::images/Ui.png[width="900"]
endif::[]

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
* Introducing *VISIT*, a Patient Tracker for Doctors-On-The-Go.
* VISIT is a desktop application that allows doctors to manage all of their _patients_ and _appointments_ in a simple, handy app.
* Doctors are able to keep track of their patients across visits, ensuring a continuity of care on subsequent visits.
* VISIT also reminds doctors of all of their upcoming appointments so that they never miss an appointment.
== Site Map

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>
* <<AboutUs#, About Us>>
* <<ContactUs#, Contact Us>>
* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>

== Acknowledgements

* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
_Marco Jakob_.
* This application is built upon AddressBook-Level3 Project created by SE-EDU initiative at https://se-education.org
* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]

== Licence : link:LICENSE[MIT]
58 changes: 33 additions & 25 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,61 @@
:imagesDir: images
:stylesDir: stylesheets

AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
{empty} +
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
VISIT is an Address Book application for Doctors to plan their visits to patients. Doctors can have granular control over each visit, log each diagnosis, schedule follow-up with patients, and keep track of their appointments.

We are Team https://github.com/AY1920S1-CS2103T-F12-2[UnrealUnity] based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].

== Project Team

=== John Doe
image::damithc.jpg[width="150", align="left"]
{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
=== Chattoraj Ayush
image::ayushchatto.png[width="150", align="left"]
{empty}[https://github.com/AyushChatto[github]] [<<AyushChatto#, portfolio>>]

Role: Project Advisor
Role: Project Advisor / Consultant

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Jason Chee
image::reignofcomputer.png[width="150", align="left"]
{empty}[https://www.reignofcomputer.com/[homepage]] [http://github.com/reignofcomputer[github]] [<<reignofcomputer#, portfolio>>]

Role: Team Lead +
Responsibilities: UI
Role: Team Lead / Managing Director +
Responsibilities: Project Manager, Developer, Legal & Compliance, Security, In charge of `Reminder-Follow-Up` Component

'''

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
=== Gabriel Chia
image::gachia.png[width="150", align="left"]
{empty}[http://github.com/gachia[github]] [<<gabrielchia#, portfolio>>]

Role: Developer +
Responsibilities: Data
Responsibilities: UI, Documentation, Concept Artist

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Jerrold Tan
image::wingedevil.png[width="150", align="left"]
{empty}[http://github.com/Wingedevil[github]] [<<jerroldtan#, portfolio>>]

Role: Developer +
Responsibilities: Dev Ops + Threading
Responsibilities: Git Expert, In charge of ‘Alias’ Component

'''

=== Benson Meier
image::yl_coder.jpg[width="150", align="left"]
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
=== Zheng Shi Qiao
image::sqwq.png[width="150", align="left"]
{empty}[http://github.com/SQwQ[github]] [<<SQwQ#, portfolio>>]

Role: Developer +
Responsibilities: UI
Responsibilities: IntelliJ Expert, Documentation, In charge of `Visit` Component

'''

=== Gabriel Ong
image::q-gabe.png[width="150", align="left"]
{empty}[https://q-gabe.me[homepage]] [http://github.com/q-gabe[github]] [<<q-gabe#, portfolio>>]

Role: Developer / Tester +
Responsibilities: Integration, Documentation, In charge of `ProfileView` Component

'''
6 changes: 3 additions & 3 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
:site-section: ContactUs
:stylesDir: stylesheets

* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
* *Bug Reports & Suggestions*: If you notice any bugs or have any suggestions on how we can improve, please post on our https://github.com/AY1920S1-CS2103T-F12-2/main/issues[issue tracker].
* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here].
* *Email us* : You can also reach us at `visit [at] roc.ms`.
224 changes: 222 additions & 2 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ifdef::env-github[]
endif::[]
:repoURL: https://github.com/AY1920S1-CS2103T-F12-2/main

By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
By: `Team UnrealUnity` Since: `Sept 2019` Licence: `MIT`

== Setting up

Expand Down Expand Up @@ -301,7 +301,15 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un

|`* * *` |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 |view the full profile of a patient by searching for his/her name |see all details regarding a patient easily

|`* * *` |user |record down details of each <<visitation,visitation>> |keep track of the patients situation

|`* * *` |user |have daily reminders of important deadlines |keep track of appointments and visitations easily

|`* * *` |user |set follow-up reminders |check in on my patients after some time or when their medication runs out

|`* * *` |user |have <<user-defined-macros,user-defined macros>> |streamline my diagnosis documentation

|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident

Expand Down Expand Up @@ -341,6 +349,212 @@ Use case ends.
+
Use case resumes at step 2.

[discrete]
=== Use case: View patient profile

*MSS*

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to view patient profile by name/index
4. AddressBook shows patient profile
+
Use case ends.

*Extensions*

[none]
* 2a. The list is empty.
+
Use case ends.
[none]
* 3. The given name/index is invalid.
+
[none]
** 3a. AddressBook shows an error message.
+
Use case resumes at step 2.

[none]
* 4. The profile is empty.
+
Use case ends.

[discrete]
=== Use case: Record visitation details

*MSS*

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to add new visitation record for a specific patient in the list
4. AddressBook adds new visitation record for chosen patient
+
Use case ends.

*Extensions*

[none]
* 2a. The list is empty.
+
Use case ends.

* 3a. The given index is invalid.
+
[none]
** 3a1. AddressBook shows an error message.
+
Use case resumes at step 2.

[discrete]
=== Use case: Edit visitation record

*MSS*

1. User requests to edit visitation record for specific patient on specific date
2. AddressBook shows pop-up form for user to edit visitation record
3. User saves edit
4. AddressBook saves edit
+
Use case ends.

*Extensions*

[none]
* 1a. The record does not exist.
+
[none]
** 1a1. AddressBook shows an error message.

Use case resumes at step 1.

* 1b. There are multiple records with the same name and date
+
[none]
** 1b1. AddressBook shows list of records and prompts user to re-enter last command with index of record to edit.

Use case resumes at step 1.

[discrete]
=== Use case: Delete visitation record

*MSS*

1. User requests to delete visitation record for specific patient on specific date
2. AddressBook deletes visitation record

+
Use case ends.

*Extensions*

[none]
* 1a. The record does not exist.
+
[none]
** 1a1. AddressBook shows an error message.

Use case resumes at step 1.

* 1b. There are multiple records with the same name and date
+
[none]
** 1b1. AddressBook shows list of records and prompts user to re-enter last command with index of record to delete.

Use case resumes at step 1.

[discrete]
=== Use case: Save user-defined macros

*MSS*

1. User requests to save user-defined macros
2. AddressBook saves user-defined macros

+
Use case ends.

*Extensions*

[none]
* 1a. The content of the macro is empty.
+
[none]
** 1a1. AddressBook shows an error message.
+
Use case resumes at step 1.

[none]
* 1b. The shortcut of the macro is illegal.
+
[none]
** 1b1. AddressBook shows an error message.
+
Use case resumes at step 1.

[discrete]
=== Use case: Invoke user-defined macros

*MSS*

1. User requests to invoke user-defined macros
2. AddressBook outputs user-defined data

+
Use case ends.

*Extensions*

[none]
* 1a. The command is not defined.
+
[none]
** 1a1. AddressBook shows an error message.
+
Use case resumes at step 1.

[discrete]
=== Use case: View reminders

*MSS*

1. User starts up AddressBook
2. Reminders are displayed

+
Use case ends.

*Extensions*

[none]
* 2. No reminders are set to show
+
[none]
** 2a. AddressBook shows no reminder message.
+
Use case ends.

[discrete]
=== Use case: View follow-up reminders

*MSS*

1. User starts up AddressBook
2. Follow-up reminders for the day are displayed

+
Use case ends.

*Extensions*

[none]
* 2. No reminders are scheduled for the day
+
[none]
** 2a. AddressBook shows no reminder message.
+
Use case ends.

_{More to be added}_

[appendix]
Expand All @@ -361,6 +575,12 @@ Windows, Linux, Unix, OS-X
[[private-contact-detail]] Private contact detail::
A contact detail that is not meant to be shared with others

[[user-defined-macros]] User-defined macros::
User-defined shortcuts for large chunks of commonly used text for diagnosis

[[visitation]] Visitation::
A housecall or appointment with the patient

[appendix]
== Product Survey

Expand Down
Loading

0 comments on commit c329609

Please sign in to comment.