Documentation ReadMe (#60)

# ReadMe ## ♻️ Current situation & Problem Would love it if everyone can read the assignment for documentation and add their sections in the README and proof read it. ## ⚙️ Release Notes Sections that still need to be done - Features (each person describe your feature) - Photos (upload your photo in the Resource folder in the project, not the one in PICS, which should only contain screenshots and update the readme - Contributions: everyone add their contributions (should be pretty similar to pdf) - Setup: I think Andreas said something about including firebase stuff? ## 📚 Documentation ## ✅ Testing ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: YurenSUN <[email protected]> Co-authored-by: abhat01 <[email protected]> Co-authored-by: karansoin <[email protected]>
CS342 · Mar 14, 2024 · 33404b4 · 33404b4
1 parent 35e98bf
commit 33404b4
Show file tree

Hide file tree

Showing 25 changed files with 103 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This source file is part of the PICS based on the Stanford Spezi Template Application project
 
-SPDX-FileCopyrightText: 2023 Stanford University
+SPDX-FileCopyrightText: 2024 Stanford University
 
 SPDX-License-Identifier: MIT
 
@@ -20,18 +20,56 @@ The CS342 2024 PICS application is using the [Spezi](https://github.com/Stanford
 > [!NOTE]  
 > Do you want to try out the CS342 2024 PICS application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/oHPpBoKG)!
 
+## Overview
+The CS342 2024 PICS application allows patients recovering from intensive care therapy to better track their recovery and inform their doctors on their health. Patients fill out necessary hospital questionnaire through the application prior to their hospital visit and track their health vitals based on their Apple health data, as well as plan and prepare for their appointments. 
 
 ## CS342 2024 PICS Features
+Our application first allows users to create an account to help keep track of their information which includes taking an onboarding questionnaire to collect their basic information, uploading a photo of their medication plan, and entering their appointment information during the onboarding process. Once users have created an account, there are five main features. 
 
-*Provide a comprehensive description of your application, including figures showing the application. You can learn more on how to structure a README in the [Stanford Spezi Documentation Guide](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/documentation-guide)*
+1. Appointments: Users can view their appointment time and the required documents to bring for each of their appointments in the form of interactive checklists. Users can also edit the appointment times in this view, and corresponding notifications will be sent 1 month, 1 week, 3 days, 1 day, and 30 minutes earlier, as well as at the time of the appointment to remind users of their upcoming appointments. There is also a map with the address at the bottom of the view to visualize the location of the appointments to help users navigate.
 
-> [!NOTE]  
-> Do you want to learn more about the Stanford Spezi Template Application and how to use, extend, and modify this application? Check out the [Stanford Spezi Template Application documentation](https://stanfordspezi.github.io/SpeziTemplateApplication)
+2. Questionnaires: Users can take the 3 main questionnaires required for each appointment directly through this app on their phone, when they navigate to the Questionnaires tab. This page helps users attempt the questionnaires in a structured manner at specific 5-minute intervals every two weeks. The UI of each task changes according to the completion state: the questionnaire task shows an incomplete yellow exclamation symbol and supporting text suggestion if the questionnaires are incomplete, and a green check mark and appropriate text if the questionnaires are completed. Besides this, if the users choose to skip the onboarding questionnaire during the onboarding process, this onboarding questionnaire will also show up in this tab. Once each questionnaire is started, one question appears per screen, and selecting an option and pressing the bottom button allows you to navigate to the next question.
+
+3. Assessments: Users can take assessments to measure their cognitive abilities. Our application includes the trail-making test, Stroop test, and reaction time test to measure different aspects of the user's cognitive skills. Results will be displayed as a chart and users can click on a dot to see more details about the selected result. Otherwise, our app will show the user's last test result for each test.
+
+4. Health Vitals: Users can view their health vitals (step counts, oxygen saturation, and heart rate) in the previous two weeks. Related details will be shown when users click on a specific bar or dot in the chart for users to learn more about their health condition. Besides, thresholds are set and shown as horizontal lines for step counts and oxygen saturation to facilitate users' understanding of their health vitals.
+
+5. Contacts: This page shows the contact information for the medical team and address information. The PICS app will direct users to the Apple Map for easier direction and navigation when users click on the address.
+
+|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/MedicationView~dark.png"><img src="Resources/MedicationView.png" width="250" alt="Screenshot displaying the Medication View." /></picture>|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/AppointmentView~dark.png"><img src="Resources/AppointmentView.png" width="250" alt="Screenshot displaying the Appointments View." /></picture>|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/QuestionnaireView~dark.png"><img src="Resources/QuestionnaireView.png" width="250" alt="Screenshot displaying the Questionnaire View." /></picture>|
+|:--:|:--:|:--:|
+|`Medication View`|`Appointments View`|`Questionniare View`|
+
+|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/AssessmentView~dark.png"><img src="Resources/AssessmentView.png" width="250" alt="Screenshot displaying the Assessment View." /></picture>|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/HealthDashboardView~dark.png"><img src="Resources/HealthDashboardView.png" width="250" alt="Screenshot displaying the Health Vitals View." /></picture>|<picture><source media="(prefers-color-scheme: dark)" srcset="Resources/ContactsView~dark.png"><img src="Resources/ContactsView.png" width="250" alt="Screenshot displaying the Contacts View." /></picture>|
+|:--:|:--:|:--:|
+|`Assessments View`|`Health Vitals View`|`Contacts View`|
 
+## Setup
+1. See setup [instructions](https://spezi.health/SpeziTemplateApplication/documentation/templateapplication/setup/) for Spezi Application
 
 ## Contributing
 
-*Ensure that you add an adequate contribution section to this README.*
+Akanshya Bhat
+- Appointments page: Homepage design, send notifications, show appointment details, map location (can-have), timeline, required documents, edit appointment information
+- Assessment page: Starting code for assessments (trail-making task)
+- Contacts page: Set up the screen with information of the PIs
+- Testing: Unit and UI tests for the Appointments and Contacts pages
+
+Catherine Zhang:
+- Onboarding Questionnaire: Create onboarding questionnaire that is optional during onboarding but must be completed on the dashboard before first appointment
+- Medication Information: Create page on the onboarding flow that allows users to upload a photo of the medication sheet received at the hospital
+- ReactionTime Assessment: Added the ReactionTime assessment to the assessment page using ResearchKit
+- Testing: UI tests for the Onboarding Flow
+
+Karan Soin
+- Questionnaires Page: UI set up and refinement for the questionnaires page. Questionnaires Scheduler to schedule the questionnaires at appropriate times, intervals, and allowing patients to retake tests if any errors occurred.
+- Assessment Tasks: Added the Stroop Test, UI Revamp for the page and all three Assessment Tests, and refinement of code, comments and overall UI
+- Testing: Both UI and Unit tests for code coverage of the the Questionnaires and Scheduler for tasks, setup initial Assessments testing 
+
+Yuren Sun:
+- Health Vitals Page: Health dashboard page set up and refinement. HealthKit samples collection and health data visualization for step count, heart rate, and oxygen saturation
+- Assessment Page: Basic UI and logic set-up of the page, assessment result parsing for Trail-making and Stroop, and visualization of results
+- Testing: Unit and UI tests for the Onboarding Flow, HealthKit Vitals page, and Assessment pages
 
 
 ## License

diff --git a/Resources/AppointmentView.png b/Resources/AppointmentView.png
diff --git a/Resources/AppointmentView.png.license b/Resources/AppointmentView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/AppointmentView~dark.png b/Resources/AppointmentView~dark.png
diff --git a/Resources/AppointmentView~dark.png.license b/Resources/AppointmentView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/AssessmentView.png b/Resources/AssessmentView.png
diff --git a/Resources/AssessmentView.png.license b/Resources/AssessmentView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/AssessmentView~dark.png b/Resources/AssessmentView~dark.png
diff --git a/Resources/AssessmentView~dark.png.license b/Resources/AssessmentView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/ContactsView.png b/Resources/ContactsView.png
diff --git a/Resources/ContactsView.png.license b/Resources/ContactsView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/ContactsView~dark.png b/Resources/ContactsView~dark.png
diff --git a/Resources/ContactsView~dark.png.license b/Resources/ContactsView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/HealthDashboardView.png b/Resources/HealthDashboardView.png
diff --git a/Resources/HealthDashboardView.png.license b/Resources/HealthDashboardView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/HealthDashboardView~dark.png b/Resources/HealthDashboardView~dark.png
diff --git a/Resources/HealthDashboardView~dark.png.license b/Resources/HealthDashboardView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/MedicationView.png b/Resources/MedicationView.png
diff --git a/Resources/MedicationView.png.license b/Resources/MedicationView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/MedicationView~dark.png b/Resources/MedicationView~dark.png
diff --git a/Resources/MedicationView~dark.png.license b/Resources/MedicationView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/QuestionnaireView.png b/Resources/QuestionnaireView.png
diff --git a/Resources/QuestionnaireView.png.license b/Resources/QuestionnaireView.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT
diff --git a/Resources/QuestionnaireView~dark.png b/Resources/QuestionnaireView~dark.png
diff --git a/Resources/QuestionnaireView~dark.png.license b/Resources/QuestionnaireView~dark.png.license
@@ -0,0 +1,5 @@
+This source file is part of the Stanford Spezi open-source project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT