Users
- Standard Users: Medical Professionals and Students
- Able to create an account and sign in on the application
- Able to see the cases they are assigned to by admins – both cases they need to fill out and cases they need to validate
- Able to view the raw data of the cases assigned to them
- Able to validate the cases they are assigned to review
- Able to view completed cases
- Admins: Member of CollectiveGood
- Have elevated access from Standard Users
- Are able to access the Admin dashboard
- Able to create an account and sign in on the application
- Able to see the cases they are to assign to users
- Able to assign a user to fill out the case and another user to validate the case
- Are able to validate the cases they are assigned to
- Able to view the completed cases
Documentation needed
User Documentation
Users will need to be able to navigate the website and use the functionality. We anticipate these users to be medical professionals, and it is important that they understand the features.
- A demo video that provides a step-by-step guide on how to navigate and use the application
- A “Help” page navigable from anywhere in the app will provide a detailed overview of the application’s functionality as well as a tutorial on how to use key features
- The user interface will make use of different colors, icons, and text in order to enhance the usability and self-documentation of the application
Administrator/Developer Documentation
Our administrators are users from CollectiveGoodMD who have access to their own version of the user documentation that includes administrator-specific abilities. They also will be able to set up and alter the application however they wish. Another important aspect will be migrating the final cases off of our starter database to the database of their existing applications.
We plan on providing some resources like demos, videos, virtual support, and API collections including what is detailed below.
- A written document and videos on how to use the administrator panel to manage the database
- High level overview of all services being used, and how/why they are in use
- Overview on how to run and deploy application
- Instructions on how to migrate data out of a database to their own servers
- Notes on what was not completed/still needs to be done (future direction)
Technical Documentation
Below is a list of what will be included in the technical documentation in order for future engineers to extend this application. This goes beyond the high-level documentation for users and administrators and covers the technical specifications and details.
- GitHub repository with a README that includes instructions on how to set up development environment
- Detailed API documentation of all endpoints using the OpenAPI specification as well as a pre-configured API collection for testing endpoints
- Overview of the organization and structure for both client-side and server-side code
The codebase itself will also focus on the use of comments, organization and readability in order to make it as easy as possible for future developers to expand on the application.
Documentation Links
Technical Documentation:
collective-good-team-a/README.md at main · CollectiveGood/collective-good-team-a (github.com)
User Manual: