Documentation Plan

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 UNC School of Psychiatry.

Documentation:

Users:

Manual on how to sign up and log in with pictures

  • As logging in and signing up is a common workflow for most modern humans, a simple manual with pictures should suffice for the few questions that come up

Admins:

Manual on setup

  • It will include:
    • environment set-up
    • installation links and step-by-step instructions for MongoDB and MongoDB Compass
    • installation instructions for NPM packages
    • instructions on how to create test users and admins inside of the system