User Documentation
Caregivers
Caretakers will have access to a quick tutorial video of the application that briefly describes each page in the app. There will also be a brief FAQ list provided.
CareYaya Staff
The CareYaya team will have a quick tutorial video on how to use the admin application. There will also be a brief FAQ list provided.
Administrator Documentation
We plan to write a document and record a video with instructions on how to set up the ML framework and the database and connect it to the app. The written instructions will go step by step of what we did to set everything up.
In our GitHub Repository, there will be README files for both the frontend and backend parts of the project. Each README will have the following:
- Instructions on how to install the necessary packages
- The backend will have a comprehensive requirements.txt file for this
- Instructions on how to run the program locally
- A file overview of where everything is, as well as the general file structure