Documentation checklist

Version 2.1

***Important Note***

Section 508 requirements for documentation have been incorporated into the IBM Accessibility Checklist, version 7.0, published on May 8, 2017. Teams should use this new checklist for web-based documentation such as:

Non-web documentation can continue to be tested against the IBM Documentation checklist version 2.1, until July 18, 2017.

IBM Documentation accessibility checklist - Version 2.1
Checkpoint Yes No
Planned
N/A
Comments
1. Provide documentation in an accessible format.


1.1 Non-text Content: All non-text content that is presented to the user has a text alternative that serves the equivalent purpose.


1.2 Information and relationships: Define information, structure, and relationships.


1.3 Color & contrast: Any information that is conveyed by color is also evident without color.


1.4 Meaningful sequence: Define document reading order.


1.5 Forms: Define form element labels.


1.6 Tables: Identify table cells and relationships between cells.


1.7 Threshold violations: Do not include text or images that flash more than 2 times in a one second period.


1.8 Navigation: Provide an accessible method to navigate long documents.


1.9 Language of page: Define the default language.

2. Document all accessibility features


2.1 Provide documentation on all accessibility features including keyboard access.

References




©2012 IBM Corporation

Last updated November 1, 2012


Join the conversation