This section contains requirements on the content of the documentation that manufacturers supply to jurisdictions that use their systems. In this context, "user" refers to election officials. The user documentation is also included in the TDP given to test labs.
It is not the intent of these requirements to prescribe an outline for user documentation. Manufacturers are encouraged to innovate in the quality and clarity of their user documentation. The intent of these requirements is to ensure that certain information that is of interest to end users and test labs alike will be included somewhere in the user documentation. To speed the test lab review, manufacturers should provide test labs with a short index that points out which sections of the user documentation are responsive to which sections of these requirements.
In the system overview, the manufacturer SHALL provide information that enables the user to identify the functional and physical components of the system, how the components are structured, and the interfaces between them.
Applies To: Voting system
Source: [VSS2002] II.2.2
The system overview SHALL include a high-level functional diagram of the voting system that includes all of its components. The diagram SHALL portray how the various components relate and interact.
Applies To: Voting system
Source: [EAC06] 4.3.2.3
The system description SHALL include written descriptions, drawings and diagrams that present:
Applies To: Voting system
Source: [VSS2002] II.2.2.1
The system description SHALL include the identification of all software and firmware items, indicating items that were:
Applies To: Voting system
Source: [VSS2002] II.2.5.3.c
The system description SHALL include a declaration that procured software items were obtained directly from the manufacturer or a licensed dealer or distributor.
Applies To: Voting system
DISCUSSION
For most noncommercial software, this would mean a declaration that the software was downloaded from the canonical site or a trustworthy mirror. It is generally accepted practice for the core contributors to major open-source software packages to digitally sign the distributions. Verifying these signatures provides greater assurance that the package has not been modified.
Source: [VSS2002] II.2.5.3
The manufacturer SHALL provide system performance information including:
Applies To: Voting system
Source: [VSS2002] II.2.2.2
The maximum tabulation rate for a central tabulator SHALL be documented by the manufacturer. This documentation SHALL include the maximum tabulation rate for individual components that impact the overall maximum tabulation rate.
Applies To: Central tabulator
DISCUSSION
The capacity to convert the marks on individual ballots into signals is uniquely important to central count systems.
Source: [VSS2002] I.3.2.5.1.1
For an optical scanner, the manufacturer SHALL document what constitutes a reliably detectable mark versus a marginal mark.
Applies To: Optical scanner
DISCUSSION
See Part 1: 7.7.5.1 “Marginal marks”. The specification may be parameterized by configuration values and should state the uncertainty.
Source: New requirement
The manufacturer SHALL provide a listing of the system's functional processing capabilities, encompassing capabilities required by the VVSG, and any additional capabilities provided by the system, with a description of each capability.
Applies To: Voting system
Source: [VSS2002] II.2.3
Manufacturers SHALL provide user documentation containing guidelines and usage instructions on implementing, configuring, and managing access control capabilities.
Applies To: Voting system
Source: [VVSG2005] I.7.2.1.2
Manufacturers SHALL provide, within the user documentation, an access control policy template or instructions to facilitate the implementation of the access control policy and associated access controls on the voting system.
Applies To: Voting system
DISCUSSION
Access control policy requirements include the minimum baseline policy definitions necessary for testing and implementation of the voting system. The policies may be pre-defined within the voting system or provided as guidelines in the documentation.
Source: [VVSG2005] I.7.2.1
Manufacturers SHALL provide, within the user documentation, a model access control policy under which the voting system was designed to operate and a description of the hazards of deviating from this policy.
Applies To: Voting system
DISCUSSION
The model access control policy includes the assumptions that were made when the system was designed, the justification for the policy, and the hazards of deviating from the policy.
Source: [VVSG2005] I.7.2.1
The manufacturer SHALL disclose and document information on all privileged accounts included on the voting system.
Applies To: Voting system
DISCUSSION
Information on privileged accounts include the name of the account, purpose, capabilities and permissions, and how to disable the account in the user documentation.
Source: [VVSG2005] I.7.2.1.2
Manufacturers SHALL provide user documentation that describes system event logging capabilities and usage.
Applies To: Voting system
Source: [VVSG2005] I.5.4
Manufacturers SHALL publicly publish fully documented log format information.
Applies To: Voting system
DISCUSSION
The log format and the meaning of all possible types of log entries must be fully documented in sufficient detail to allow independent manufacturers to implement utilities to parse the log file. This documentation must be publicly available, free of charge, and not just in the TDP. The documentation may be housed by the EAC or the test lab.
Source: [VVSG2005] I.5.4
The manufacturer SHALL provide a list of all software to be installed on the programmed devices of the voting system and installation software used to install the software in the user documentation.
Applies To: Programmed device
DISCUSSION
Software to be installed on programmed devices of the voting system includes executable code, configuration files, data files, and election specific software.
The manufacturer SHALL provide at a minimum in the user documentation the following information for each piece of software to be installed or used to install software on programmed devices of the voting system: software product name, software version number, software manufacturer name, software manufacturer contact information, type of software (application logic, border logic, third party logic, COTS software, or installation software), list of software documentation, component identifier(s) (such filename(s)) of the software, type of software component (executable code, source code, or data).
Applies To: Programmed device
The manufacturer SHALL provide in the user documentation the location (such as full path name or memory address) and storage device (such as type and part number of storage device) where each piece of software is installed on programmed devices of the voting system.
Applies To: Programmed device
DISCUSSION
This requirement applies to software installed on programmed devices of the voting system. The full directory path is the final destination of the software when installed on non-volatile storage with a file system.
The manufacturer SHALL identify election specific software in the user documentation.
Applies To: Programmed device
The manufacturer SHALL provide a list of software and hardware required to install software on programmed devices of the voting system in the user documentation.
Applies To: Programmed device
The manufacturer SHALL document the software installation procedures used to install software on programmed devices of the voting system in user documentation.
Applies To: Programmed device
Source: [VVSG2005] Volume III, Section 2.2.3(a)
The software installation procedures used to install software on programmed devices of the voting system SHALL result in no compilers being installed on the programmed device.
Applies To: Programmed device
To replicate programmed device configurations, the software installation procedures SHALL create a baseline binary image of the initial programmed device configuration on an unalterable storage media with a digital signature.
Applies To: Programmed device
DISCUSSION
Unalterable storage media includes technology such as a CD-R, but not CD-RW.
The software installation procedures SHALL use the baseline binary image of the initial programmed device configuration on an unalterable storage media to replicate the configuration on to other programmed devices.
Applies To: Programmed device
DISCUSSION
Unalterable storage media includes technology such as a CD-R, but not CD-RW.
The software installation procedures SHALL specify the creation of a software installation record that includes at a minimum: a unique identifier (such as a serial number) for the record; a list of unique identifiers of unalterable storage media associated with the record; the time, date, and location of the software installation; names, affiliations, and signatures of all people present; copies of the procedures used to install the software on the programmed devices of the voting system; the certification number of the voting system; list of the software installed on programmed devices of the voting system; and a unique identifier (such as a serial number) of the vote-capture device or EMS which the software is installed.
Applies To: Programmed device
The software installation procedures SHALL specify that voting system software be obtained from test labs or distribution repositories.
Applies To: Programmed device
DISCUSSION
Distribution repositories provide software they receive to parties approved by the owner of the software.
The software installation procedures SHALL specify that COTS software be obtained from the open market.
Applies To: Programmed device
The software installation procedures SHALL specify how previously stored information on erasable storage media is removed before installing software on the media.
Applies To: Programmed device
DISCUSSION
The purpose of this requirement is to prepare erasable storage media for use by the programmed devices of the voting system. The requirement does not require the prevention of previously stored information leakage or recovery. Simply deleting files from file systems, flashing memory cards, and removing electrical power from volatile memory satisfies this requirement.
The software installation procedures SHALL specify that unalterable storage media be used to install software on programmed devices of the voting system.
Applies To: Programmed device
DISCUSSION
Unalterable storage media includes technology such as a CD-R, but not CD-RW.
Manufacturer SHALL provide user documentation explaining the implementation of all physical security controls for the voting device, including model procedures necessary for effective use of countermeasures.
Applies To: Voting device
The manufacturer SHALL provide a model setup inspection process that the voting device was designed to support and description of the risks of deviating from the process in the user documentation.
Applies To: Voting device
DISCUSSION
The model setup inspection process provides a means to inspect various properties of voting devices as needed during the election process.
A model setup inspection process SHALL at a minimum include the inspection of voting system software, storage locations that hold election information that changes during an election, other voting device properties, and execution of logic and accuracy testing related to readiness of use in an election.
Applies To: Voting device
DISCUSSION
See requirements in Part 1: 5.2 “Setup Inspection”.
Source: [VVSG2005] I.7.4.6 (a) and (f)
The model setup inspection process SHALL describe the records that result from performing the setup inspection process.
Applies To: Voting device
Source: [VVSG2005] I.5.4.2
The manufacturer SHALL provide the procedures to identify all software installed on programmed devices of the voting system in the user documentation.
Applies To: Programmed device
DISCUSSION
This requirement provides the ability to identify if the proper software is installed and that no other software is present on programmed devices of the voting system. This requirement covers software stored on storage media with or without a file system.
Source: [VVSG2005] I.7.4.6 (b)(ii)
The manufacturer SHALL describe the procedures to verify the integrity of software installed on programmed devices of voting system in the user documentation.
Applies To: Programmed device
Source: [VVSG2005] I.7.4.6 (b)(ii)
The manufacturer SHALL provide the values of voting device storage locations that hold election information that changes during the election, except for the values set to conduct a specific election in the user documentation.
Applies To: Voting device
Source: [VVSG2005] I.7.4.6 (f)(ii)
The manufacturer SHALL provide the maximum and minimum values voting device storage locations that hold election information changes during an election can store in the user documentation.
Applies To: Voting device
Source: [VVSG2005] I.7.4.6 (f)(ii)
The manufacturer SHALL provide the procedures to inspect the values of voting device storage locations that hold election information that changes for an election in the user documentation.
Applies To: Voting device
Source: [VVSG2005] I.7.4.6 (f)(i)
The manufacturers SHALL provide the nominal operational range for the backup power sources of the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the remaining charge of the backup power sources of the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the connectivity of the cabling attached to the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the operational status of the communications capabilities of the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the on/off status of the communications capabilities of the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide a list of consumables associated with the voting device, including estimated number of usages per quantity of consumable in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the remaining amount of each consumable of the voting device in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide a list of components associated with the voting device that require calibration and the nominal operating ranges for each component in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to inspect the calibration of each component in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide the procedures to adjust the calibration of each component in the user documentation.
Applies To: Voting device
The manufacturer SHALL provide a model checklist of other properties of the voting device to be inspected, including a description of the risks on not performing a given inspection in the user documentation.
Applies To: Voting device
DISCUSSION
Voting devices may have other properties that need to be inspected that are not covered in Part 1: 5.2 “Setup Inspection”. This requirement provides a mechanism for the properties not covered in Part 1 Section 5.2 to be captured.
The model checklist of other properties of the voting device to be inspected SHALL at a minimum include: the inspection of backup power sources, cabling, communications capabilities, consumables, calibration of voting device components, general physical features of the voting device, and securing external interfaces of the voting device not being used.
Applies To: Voting device
DISCUSSION
Voting device may have other properties that need to be inspected that are not covered in Part 1: 5.2 “Setup Inspection”. This requirement provides a mechanism for the properties not covered in Part 1 Section 5.2 to be captured.
The voting system’s user documentation SHALL fully specify a secure, transparent, workable and accurate process for producing all records necessary from the devices and carrying out the pollbook audit.
Applies To: Voting system
DISCUSSION
In order to fully support the pollbook audit, the voting system documentation must provide enough information for election officials to carry out the auditing step. This includes explaining how to generate all needed reports, how to check the reports against one another for agreement, and how to deal with errors and other unusual problems that come up during the audit step.
The voting system’s user documentation SHALL fully specify a secure, transparent, workable and accurate process for producing all records necessary from the devices and carrying out the hand audit.
Applies To: Voting system
DISCUSSION
The user documentation must explain how to produce all necessary reports and reconcile the records by hand-auditing.
The voting system’s user documentation SHALL fully specify a secure, transparent, workable and accurate process for producing all records necessary from the devices and carrying out the final election tally.
Applies To: Voting system
DISCUSSION
In order to fully support the audit, the voting system documentation must provide enough information for election officials to carry out the auditing step. This includes explaining how to generate all needed reports, how to check the reports against one another for agreement, and how to deal with errors and other unusual problems that come up during the audit step.
The voting system’s user documentation SHALL fully specify a secure, transparent, workable and accurate process for observational testing.
Applies To: Voting system
The manufacturer SHALL provide documentation for a procedure to scan VVPAT VVPR by optical character recognition.
Applies To: VVPAT
Source: [VVSG2005] I.7.9.3-g
The system operations manual SHALL provide all information necessary for system use by all personnel who support pre-election and election preparation, polling place activities, and central counting activities, as applicable, with regard to all system functions and operations identified in Part 2: 4.2 “System Functionality Description”.
Applies To: Voting system
DISCUSSION
The nature of the instructions for operating personnel will depend upon the overall system design and required skill level of system operations support personnel.
Source: [VSS2002] II.2.8
The system operations manual SHALL contain all information that is required for the preparation of detailed system operating procedures and for the training of administrators, central election officials, election judges, and poll workers.
Applies To: Voting system
Source: [VSS2002] II.2.8
The manufacturer SHALL provide a summary of system operating functions and modes to permit understanding of the system's capabilities and constraints.
Applies To: Voting system
Source: [VSS2002] II.2.8.1
The roles of operating personnel SHALL be identified and related to the operating modes of the system.
Applies To: Voting system
Source: [VSS2002] II.2.8.1
Decision criteria and conditional operator functions (such as error and failure recovery actions) SHALL be described.
Applies To: Voting system
Source: [VSS2002] II.2.8.1
The manufacturer SHALL also list all reference and supporting documents pertaining to the use of the system during election operations.
Applies To: Voting system
Source: [VSS2002] II.2.8.1
The manufacturer SHALL describe the system environment and the interface between the election official or voter and the system.
Applies To: Voting system
Source: [VSS2002] II.2.8.2
The manufacturer SHALL identify all facilities, furnishings, fixtures, and utilities that will be required for equipment operations, including equipment that operates at the:
Applies To: Voting system
Source: [VSS2002] II.2.8.2
The user documentation supplied by the manufacturer SHALL include a statement of all requirements and restrictions regarding environmental protection, electrical service, recommended auxiliary power, telecommunications service, and any other facility or resource required for the proper installation and operation of the system.
Applies To: Voting system
Source: [VSS2002] I.3.2.2
The manufacturer SHALL provide specifications for testing of system installation and readiness.
Applies To: Voting system
DISCUSSION
Readiness testing refers to steps that election officials can take after deploying and configuring equipment to establish that it was correctly deployed and configured. Logic and accuracy testing would be part of this.
Source: [VSS2002] II.2.8.3
These specifications SHALL cover testing of all components of the system and all locations of installation (e.g., polling place, central count facility), and SHALL address all elements of system functionality and operations identified in Part 2: 4.2 “System Functionality Description” above, including general capabilities and functions specific to particular voting activities.
Applies To: Voting system
Source: [VSS2002] II.2.8.3
The manufacturer SHALL provide documentation of system operating features that includes:
Applies To: Voting system
Source: [VSS2002] II.2.8.4
For systems that support straight party voting, the manufacturer SHALL document the available algorithms for counting straight party overrides.
Applies To: Straight party voting
DISCUSSION
See Requirement Part 1: 7.7.2-A.12.
Source: New requirement
For systems that support write-in voting, the manufacturer SHALL document the available algorithms for reconciling write-in double votes.
The manufacturer SHALL provide documentation of system operating procedures that:
Applies To: Voting system
Source: [VSS2002] I.2.3.3.a and II.2.8.5
Manufacturers of VVPATs SHALL provide documentation for procedures to recover from VVPAT printer errors and faults including procedures for how to cancel a vote suspended during an error.
Applies To: VVPAT
DISCUSSION
If the printer irrecoverably locks up, the vote needs to be able to be canceled, so the voter can cast a vote on another device. Alternatively, it would be okay to store the vote as is, if the vote is complete. This requirement restates [VVSG2005] I.7.9.4-k by requiring documentation for recovering from printer errors.
Source: [VVSG2005] I.7.9.4-k
Manufacturers of paper-roll VVPATs SHALL provide documentation describing necessary procedures for handling the paper roll in a way that preserves voter privacy.
Applies To: VVPAT
DISCUSSION
Along with a secure, opaque container designed to accommodate tamper-seals and a lock, the voting system needs to document what must be done to protect voter privacy with the paper rolls. The goal of this requirement is to ensure that the election officials are given guidance on exactly what must be done to protect the privacy of voters.
Source: [VVSG2005] I.7.9.5-b
Documentation for poll workers is covered under Part 1: 3.2.8 “Usability for poll workers” and 3.3.1 “General”.
The manufacturer SHALL provide documentation of system operating procedures that:
Applies To: Voting system
Source: [VSS2002] II.2.8.6
The manufacturer SHALL include any special instructions for preparing voting devices for shipment.
Applies To: Voting system
Source: New requirement
The manufacturer SHALL include any special storage instructions for voting devices.
Applies To: Voting system
Source: [VSS2002] I.3.2.2.1
The manufacturer SHALL detail the care and handling precautions necessary for removable media and records to satisfy Requirement Part 1: 6.5.1-A.
Applies To: Voting system
Source: New requirement
The manufacturer may provide descriptive material and data supplementing the various sections of the body of the system operations manual. The content and arrangement of appendices are at the discretion of the manufacturer. Topics recommended for discussion include:
The system maintenance manual SHALL provide information to support election workers, information systems personnel, or maintenance personnel in the adjustment or removal and replacement of components or modules in the field.
Applies To: Voting system
DISCUSSION
Technical documentation needed solely to support the repair of defective components or modules ordinarily done by the manufacturer or software developer is not required.
Source: [VSS2002] II.2.9
The manufacturer SHALL describe service actions recommended to correct malfunctions or problems; personnel and expertise required to repair and maintain the system, equipment, and materials; and facilities needed for proper maintenance.
Applies To: Voting system
Source: [VSS2002] II.2.9
The manufacturer SHALL describe the structure and function of the hardware, firmware and software for election preparation, programming, vote recording, tabulation, and reporting in sufficient detail to provide an overview of the system for maintenance and for identification of faulty hardware or software.
Applies To: Voting system
Source: [VSS2002] II.2.9.1
The description SHALL include a concept of operations that fully describes such items as:
Applies To: Voting system
Source: [VSS2002] II.2.9.1
The manufacturer SHALL describe preventive and corrective maintenance procedures for hardware, firmware and software.
Applies To: Voting system
Source: [VSS2002] II.2.9.2
The manufacturer SHALL identify and describe:
Applies To: Voting system
Source: [VSS2002] II.2.9.2.1
The manufacturer SHALL provide fault detection, fault isolation, correction procedures, and logic diagrams for all operational abnormalities identified by design analysis and operating experience.
Applies To: Voting system
Source: [VSS2002] II.2.9.2.2
The manufacturer SHALL identify specific procedures to be used in diagnosing and correcting problems in the system hardware, firmware and software. Descriptions shall include:
Applies To: Voting system
Source: [VSS2002] II.2.9.2.2
The manufacturer SHALL identify and describe any special purpose test or maintenance equipment recommended for fault isolation and diagnostic purposes.
Applies To: Voting system
Source: [VSS2002] II.2.9.3
Manufacturers SHALL provide detailed documentation of parts and materials needed to operate and maintain the system.
Applies To: Voting system
Source: [VSS2002] II.2.9.4
The manufacturer SHALL provide a complete list of approved parts and materials needed for maintenance. This list SHALL contain sufficient descriptive information to identify all parts by:
Applies To: Voting system
Source: [VSS2002] I.3.4.1.b, II.2.9.4.1
The manufacturer SHALL identify specific marking devices that, if used to make the prescribed form of mark, produce readable marked ballots so that the system meets the performance requirements for accuracy.
Applies To: Optical scanner
DISCUSSION
Includes pens and pencils for MCOS or the appropriate EBM for ECOS.
Source: Simplified from [VSS2002] I.3.2.4.2.3
For marking devices manufactured by multiple external sources, the manufacturer SHALL specify a listing of sources and model numbers that satisfy these requirements.
Applies To: Voting system
Source: [VSS2002] I.3.2.4.2.3.c and II.2.9.4.2
The manufacturer SHALL specify the required paper stock, weight, size, shape, opacity, color, watermarks, field layout, orientation, size and style of printing, size and location of vote response fields and to identify unique ballot styles, placement of alignment marks, ink for printing, and folding and bleed-through limitations for preparation of ballots that are compatible with the system.
Applies To: Paper-based device
Source: [VSS2002] I.2.3.1.3.1.c, I.3.2.4.2.1.c, II.2.9.4.2
User documentation for optical scanners SHALL include specifications for ballot materials to ensure that votes are read from only a single ballot at a time, without bleed-through or transferal of marks from one ballot to another.
Applies To: Optical scanner
Source: [VSS2002] I.2.3.1.3.2, revised
User documentation for voting systems that include printers SHALL include specifications of the paper necessary to ensure correct operation, minimize jamming, and satisfy Requirement Part 1: 6.4.4-B and Requirement Part 1: 6.5.1-A.
Applies To: Voting system
DISCUSSION
This requirement covers all printers, either stand-alone or integrated with another device, regardless whether they are used for reporting, for logging, for VVPR, etc.
Source: New requirement
The manufacturer SHALL identify all facilities, furnishings, fixtures, and utilities that will be required for equipment maintenance.
Applies To: Voting system
Source: [VSS2002] II.2.9.5
Manufacturers SHALL specify:
Applies To: Voting system
Source: [VSS2002] I.3.4.5, II.2.9.5
The manufacturer may provide descriptive material and data supplementing the various sections of the body of the system maintenance manual. The content and arrangement of appendices are at the discretion of the manufacturer. Topics recommended for amplification or treatment in appendix include:
The manufacturer SHALL describe the personnel resources and training required for a jurisdiction to operate and maintain the system.
Applies To: Voting system
Source: [VSS2002] II.2.10
The manufacturer SHALL specify the number of personnel and skill levels required to perform each of the following functions:
Applies To: Voting system
Source: [VSS2002] II.2.10.1
The manufacturer SHALL distinguish which functions may be carried out by user personnel and which must be performed by manufacturer personnel.
Applies To: Voting system
Source: [VSS2002] II.2.10.1
The manufacturer SHALL specify requirements for the orientation and training of administrators, central election officials, election judges, and poll workers.
Applies To: Voting system
Source: [VSS2002] II.2.10.2