Team F — Documentation Plan
COMP 523 | ACCIDDA Measles Vaccination Coverage Dashboard
Status: Under Review
1. Overview
Our team is extending ACCIDDA's Measles Vaccination Coverage Dashboard to support standardized state-specific data repositories. Our documentation will focus on helping users navigate the dashboard, contributors add new state data, and administrators maintain the application.
We plan to keep documentation concise and accessible, prioritizing workflows that are not immediately obvious from the interface.
2. User Audiences
| Audience | Technical Skill Level | Documentation Needs |
|---|---|---|
| Public dashboard users | Basic | Understanding visualizations, interpreting missing data, and navigating the dashboard |
| State-data contributors | Intermediate | Preparing CSV files, validating data, and submitting state repositories |
| Dashboard administrators | Intermediate–advanced | Reviewing state registrations, deploying updates, and troubleshooting |
3. Public Dashboard Documentation
No additional public dashboard documentation is needed. The dashboard already provides a first-visit “How to” guide that explains how to navigate the site and use its features.
4. State Contributor Documentation
Our most detailed documentation will focus on adding new state data, since this process requires technical knowledge and several steps.
We will update the measles-AA repository README to explain how contributors can:
- Create a measles-XX repository from the template.
- Format vaccination data according to the required CSV schema.
- Run preparation scripts, validation tools, and automated tests.
- Interpret validation errors and confirm GitHub Actions checks pass.
- Submit a pull request to register their state in the central dashboard.
- Update state data after initial registration.
We will include example commands, sample data references, and troubleshooting guidance. Documentation will clarify that creating a state repository does not automatically make it available in the dashboard; an administrator must approve and register the state.
We also plan to create a short video tutorial (approximately 5–7 minutes) demonstrating the state contribution process using the repository template, sample data, validation tools, and registration pull request. The video will be linked from our project website and shared with ACCIDDA at handoff.
5. Administrator Documentation
We will maintain administrator instructions in the central dashboard repository, building on existing documentation where appropriate.
These instructions will cover local setup and dependencies, configuration, GitHub Pages deployment, and reviewing state-registration pull requests. We will also explain how to verify successful data loading, investigate unavailable state data, troubleshoot deployment failures, and restore a previous working deployment.
Administrator instructions will remain separate from developer-focused architecture documentation.
6. Documentation Delivery and Accessibility
We will primarily use GitHub Markdown documentation because it is easy to maintain alongside the code and familiar to the technical contributors and administrators working with the repositories.
Public-facing guidance is already incorporated into the dashboard, while technical documentation will remain in the relevant repositories. Our project website will link to the state contribution video and key documentation resources.
We will use clear headings, concise instructions, readable examples, and descriptive links. The instructional video will include captions, and its essential steps will also be available in writing.
7. Documentation Verification
We will develop and update documentation as implementation progresses. Before final delivery, we will verify that instructions match the completed software, commands work as described, and all documentation and video links are accessible.
When possible, a team member unfamiliar with a particular workflow will follow the instructions to identify unclear steps. We will avoid documenting features that have not been implemented.