Since this is a ongoing project, and we have only added a small subset of the features, most of the documentation will be reused from the previous semester. Our new features, and this documentation plan only cover the authorization portion of the website, the rest will be adopted from the previous semesters.
Users:
Our users are the employees at UNC School of Psychiatry, external evaluation partners, and mental health agencies.
Documentation:
Superadmins, Admins and Providers:
Manual on how to sign up and log in will include instructions and pictures about the following actions:
- Signup for superadmin is only enabled for invited superadmins; invitation link for sign up is sent via email by an existing superadmin.
- Signup for admin is only enabled for invited admins; invitation link for sign up is sent via email by an existing superadmin.
- Signup for provider is only enabled for invited providers; invitation links for sign up is sent via email by an existing superadmin.
- After a user is signed up and verified their own email, they will be able to log in.
Manual on role-specific features will include instructions and pictures about the following actions:
- For superadmin: how to invite others as superadmins, admins, or providers; how to view all data provided by everyone
- For admin: how to view all data provided by everyone
- For provider: how to view data provided by themselves
Superadmins:
Manual on setup will include:
- Installation links and step-by-step instructions for MongoDB and MongoDB Compass
- Installation instructions for NPM packages
- Environment set-up instructions
- Instructions on how to create test users, admins, and superadmins inside the system
Documentation Links
User Manual: