Participant Record Dashboard: Documentation for users
- Dominant language
- JavaScript
- Stars
- 363
- Forks
- 872
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 18
Description
### Dependency
- https://github.com/hackforla/website/issues/7640
### Overview
We need to create user-facing documentation for the Participant Record Card Dashboard so that participants and the program managers to understand how to access, complete, submit, and manage their Participant Record throughout their engagement. This will reduce confusion, minimize support requests, and ensure accurate participitation tracking and reporting.
### Action Items
- [ ] Outline the list of documentation topics
- [ ] Create individual documentation pages or sections for each major topic
Will contain details about how will the following things happen and in what order:
Offer letter with ID and passcode
Participant Record
Issue Updates
Reminders
Will contain instructions for how to
- Participants
- start a new participant record
- record hours
- submit a participant record
- get edit access after participant record closed
- report breaks and absence
- reactivate access
- end engagement
- view and share participant record
- Appeal Audit Results
- Audit prep if your GitHub Account has been deleted
- Program Managers
- reopen and give access to a closed participant record
- Audit
- Audit if Participant's GitHub Account has been deleted
- Understand the All Users Reports
- All
- Access and understand the user Dashboard
Additional items
- Rules
- for absences
- when to fill out participant records / when they are due
- GitHub Account Deletion
### Resources/Instructions
- Requirements Document [HfLA website: Dashboard Requirements: Participant Record v3](https://docs.google.com/document/d/1lYeY2T_sNU4gjyj_P8C2LBrnzsuIZcR4-bd7GxzbWr8/)
#### Participant Record Dashboard Prototype Link
- Draft Spreadsheet [User Report Lookup Draft](https://docs.google.com/spreadsheets/d/10oqrFfqMELuBUPwQQGgBscmdF7FTG61aSLbXqju3wSM/edit?gid=1018556720#gid=1018556720)
Contributor guide
Assessment
This issue has not been assessed yet.