Documentation:Working Drafts April
Contents |
Working Drafts for Information, Documentation and Support
Revisions and addition to § 1194.41 Information, documentation, and support.
This page compiles current drafts into one page for easier reference. See the Topic List for history and discussion. New provisions are listed at the end of revisions to the current provisions, in no particular order.
Current drafts (working - from May meeting)
(a) Documentation provided in an accessible format
To provide documentation to users on the installation, configuration and use of the product, Federal agencies shall require that all documentation supporting the product, including but not limited to reports, system documentation and user training or technical support materials conform the relevant accessibility provisions in 1194 Subparts B and C.
Best Practice Discussion: If the documentation supporting the product, reports or other documentation are to be provided via a contract, then the contract must include this requirement.
(b) Documentation includes accessibilty and compatibility features
Product documentation shall provide users with a description of the accessibility and compatibility features of the product, including how to install and activate them. This information shall be provided in alternate formats or alternate methods upon request.
Best Practice Discussion: If the descriptions for the users regarding the accessibility and compatibility features of products in alternate formats are to be provided via a contract, then the contract should include this requirement.
Best Practice Discussion: When the descriptions are posted online, links to any alternative formats should be available within close proximity to the original content.
(c) Appropriate communication methods
Support services for products shall accommodate the communication needs of end-users with disabilities.
Best Practices Discussion Appropriate telecommunication media, include but are not limited to TTY, relay service, and video conference. Instructions should include appropriate interaction mechanism, including but not limited to keyboard equivalents required.
(d) Documentation of keyboard shortcuts
Information about keyboard shortcuts shall be made available in documentation.
1. All shortcuts for keyboard operation shall be enumerated in one place for easy reference.
2. When the documentation lists specific mouse based actions, the keyboard commands shall also be listed.
Best practices discussion: The purpose of these points is to ensure someone using the keyboard as a primary device has a complete set of instructions and doesn't have to look in a separate reference table for the information.
(e) Best practice guidelines for documentation
NOTE: THESE ARE DRAFTED AS AN EXAMPLE FOR HOW GOOD PRACTICE COULD BE INCLUDED IN THE STANDARD OR IN A GUIDANCE DOCUMENT. THEY ARE WRITTEN AS "SHOULD" STATEMENTS TO MAKE IT CLEAR THAT THEY ARE RECOMMENDED, NOT REQUIRED.
Best practices for providing documentation to people with disabilities that should be included are:
1. Context-sensitive help, which offers documentation or support for the features and functions of the current page, screen or window should be offered, using a consistent set of accessible commands to access it.
2. Remote assistance programs allow someone to access a computer system remotely to provide support or instruction. This ability to demonstrate features of the computer software or hardware is helpful to people with cognitive disabilities. Applications should either make such a feature available or not disrupt tools that provide it.
3. Documentation and training materials should include text descriptions of the interface. These descriptions should stand on their own and be understandable without relying on graphic images in the materials.
4. Descriptions of a user interface should refer to elements by name or function, in addition to their location in the visual interface.
Current 508 Language (for reference)
Subpart D -- Information, Documentation, and Support § 1194.41 Information, documentation, and support.
(a) Product support documentation provided to end-users shall be made available in alternate formats upon request, at no additional charge.
(b) End-users shall have access to a description of the accessibility and compatibility features of products in alternate formats or alternate methods upon request, at no additional charge.
(c) Support services for products shall accommodate the communication needs of end-users with disabilities.
