docs-vxsuite-v4

Repository Structure

• conformity-matrix/ contains a matrix of each VVSG2 requirement with a brief description of how VxSuite meets the requirement, how VotingWorks tests meeting the requirement, and a reference to where to find more documentation supporting this requirement in the Technical Data Package (TDP).
• docs-vxsuite-v4-tdp is a submodule containing the content of the VxSuite TDP that is publicly avialable at: https://docs.voting.works/vxsuite-tdp-v4
• docs-vxsuite-v4-user-manual is a submodule containing the of the VxSuite User Manual that is publicly available at: https://docs.voting.works/vxsuite-user-manual-v4
• hardware-assets/
  • BOMs/ contains the detailed Bill of Materials for each component in the system
  • cots-documentation/ contains all of the data sheets for COTS products used in the system
  • drawings/ contains all of the mechanical drawings for manufactured parts in the system
  • workplans/ contains detailed instructions for assembling the system
• quality-assurance/ contains documents used in the VotingWorks quality assurance process
  • production/ contains QA documentation used in voting system component production
  • testing/ contains test results for the system performed by either external bodies or by VotingWorks
• risk-assessment/ contains a risk assessment for the voting system per VVSG 14.1
• uat-reports/ contains the voter and poll worker reports from usability and accessibility testing
• warranty-model/ contains a copy of the VotingWorks service contract

Downloading Documentation

Documentation available at docs.voting.works is available for PDF download or printing on the website by clicking Export as PDF. Click All pages for the entirety of either the TDP or User Manual. Then click the print icon to send to printer or save as PDF.

The files in this repository are available for download as a .zip file by clicking Code > Download Zip. Submodules are available for download in the same manner from their respective linked repositories.

To save all documentation in one folder:

• Clone this repo git clone https://github.com/votingworks/docs-vxsuite-v4
• Initialize and populate the submodule directories git submodule update --init

Hosted Documentation Search

For ease of navigation, a search feature is also available for documents available at docs.voting.works by clicking Ask or search or ctrl-K when viewing the documentation. You can search for a given section of the documentation or ask a question in natural language and receive an AI summarized answer based on the documentation content.

Code Repositories

This repository documents the following code repositories that comprise the voting system:

• vxsuite — Core application code
• kiosk-browser — Generic Electron-based kiosk-mode browser
• vxsuite-complete-system — Links compatible versions of vxsuite and kiosk-browser, and includes the scripts necessary to create a production machine
• vxsuite-build-system — Our framework for building VxSuite and managing its dependencies, across versions and environments

Software installation documentation also refers to vx-iso, which is the VotingWorks-specific ISO installer program.