Thread Subject: Re: Subpart D: 1.1-B KeyboardShortcuts (documentation)

Note

This archival content is maintained by WebAIM and NCDAE on behalf of TEITAC and the U.S. Access Board . Additional details on the updates to section 508 and section 255 can be found at the Access Board web site.

From: Judy Brewer
Date: Tue, Mar 25 2008 11:05 AM

(Whitney -- Thanks for adding it.
<http://teitac.org/wiki/EWG:OpenProvisions_March_12#1.1-B_-_Keyboard_Shortcuts_.28Discussed_Feb_5.2C_12.29>)

Andi,

You said

>not all products have context-sensitive help or even online Help so
>I'm not sure we can satisfactorily define "centrally located user
>documentation.

and so you proposed:

>...must be listed in user documentation, such as online help,
>context-sensitive help, or printed user's guides.

but "printed user's guides" doesn't necessarily help someone with
limited use of their hands, and so if this is listed as an acceptable
sole method of meeting the requirement, it doesn't meet the user need.

While all apps may not have context-sensitive help or online help,
all serious apps at least have online documentation, right? So how
about instead:

"Information about keyboard shortcuts, including available keyboard
commands and keyboard navigation mechanisms, must be listed in
online documentation."

along with the note from Andrew and Mike:

Note: The inclusion of a documented comprehensive listing of keyboard
shortcuts for an application is suggested as some users benefit from a
single, centralized resource.

Does that work for you?

Regards,

- Judy


At 11:25 AM 3/25/2008 -0500, Whitney Quesenbery wrote:
>I've added both the new suggested text and note to the Open Provisions page.
>
>W
>
>At 09:46 AM 3/25/2008, you wrote:
> >Sounds good to me, Andi.
> >
> >How about this:
> >
> >Note: The inclusion of a comprehensive listing of keyboard shortcuts for
> >an application is suggested as some users benefit from a single,
> >centralized resource.
> >
> >AWK
> > > -----Original Message-----
> > > From: = EMAIL ADDRESS REMOVED = [mailto:teitac-
> > > = EMAIL ADDRESS REMOVED = ] On Behalf Of Andi Snow-Weaver
> > > Sent: Tuesday, March 25, 2008 8:42 AM
> > > To: TEITAC Committee
> > > Subject: Re: [teitac-committee] Subpart D: 1.1-B KeyboardShortcuts
> > > (documentation)
> > >
> > > Judy,
> > >
> > > I think Sean commented offline that we would have to explain "keyboard
> > > shortcuts and implicit designators". Also, not all products have
> > > context-sensitive help or even online Help so I'm not sure we can
> > > satisfactorily define "centrally located user documentation".
> > >
> > > We could generalize "keyboard shortcuts" to "keyboard operation".
> > >
> > > Proposal:
> > >
> > > "Information about keyboard operation, including available keyboard
> > > commands and keyboard navigation mechanisms, must be listed in user
> > > documentation, such as online help, context-sensitive help, or printed
> > > user's guides."
> > >
> > > Maybe we could also include a note that a single list of the keyboard
> > > shortcuts is beneficial. Sorry that I'm not proposing such a note but
> > > I'm
> > > having trouble coming up with the words this morning.
> > >
> > > Andi
> > >
> > >
> > >
> > >
> > > Judy Brewer
> > > < = EMAIL ADDRESS REMOVED = >
> > > Sent by:
> > > To
> > > teitac-committee- TEITAC Committee
> > > = EMAIL ADDRESS REMOVED = <teitac-
> > > = EMAIL ADDRESS REMOVED = >
> > > ac.org
> > > cc
> > >
> > >
> > > Subject
> > > 03/24/2008 01:36 [teitac-committee] Subpart D:
> > > 1.1-B
> > > PM Keyboard Shortcuts
> > > (documentation)
> > >
> > > Please respond to
> > > TEITAC Committee
> > > <teitac-committee
> > > @list.teitac.org>
> > >
> > >
> > >
> > >
> > >
> > >
> > > For documentation of keyboard shortcuts, I propose using version 5
> > > (existing proposal, at):
> > > http://teitac.org/wiki/EWG:OpenProvisions_March_12#7-D_-
> > > _Accessible_Templates_.28Discussed_Jan_9.29
> > >
> > > unless version 6 (below) is considered an improvement. I also
> > > proposing an additional note, below, regarding "centrally located":
> > >
> > > Version 5 seems preferable to versions 2 and 3, as it does not mix in
> > > the issue of programmatic access to AT, which has been moved to
> > > 3.U.1.g. It also seems preferable to version 4, as it does not add in
> > > "printed documentation" as one of the ways of meeting this provision,
> > > since that is of relatively less help to someone with limited use of
> > > their hands, compared to the other two options.
> > >
> > > The text of version 5 currently reads:
> > >
> > > "Information about keyboard shortcuts, including available keyboard
> > > commands and keyboard navigation mechanisms, must be listed in
> > > centrally located user documentation, and available in
> > > context-sensitive
> > > help."
> > >
> > > If however the substitution of "implicit designators" would be
> > > preferable, we could instead use:
> > >
> > > Version 6:
> > >
> > > "Information about keyboard shortcuts and implicit designators
> >must
> > > be
> > > listed in centrally located user documentation, and available in
> > > context-sensitive
> > > help."
> > >
> > > In addition, I believe we need a note scoping "centrally located user
> > > documentation", such as:
> > >
> > > "Note: Centrally located user documentation can be in more than
> >one
> > > location, but should be able to be located through application
> > > help."
> > >
> > > Regards,
> > >
> > > - Judy
> > >
> > > At 06:27 PM 3/22/2008 -0400, Mike Paciello wrote:
> > > >Peter / Judy / Andi -
> > > >
> > > >In an effort to bring this provision to closure, would it be
> > > >possible for you to agree to use one of the two versions that you
> > > >currently have proposed -- at least as a starting point? Currently
> > > >you have the following 2 versions:
> > > >
> > > >Version 4: (first proposal from Judy/Peter):
> > > >Information about keyboard shortcuts, including keyboard commands
> > > >and keyboard navigation mechanisms, must be documented in at least
> > > >one of the following places:
> > > >
> > > >1. integrated help system / context-sensitive help
> > > >2. centralized on-line documentation
> > > >3. printed user documentation
> > > >
> > > >When the documentation lists specific pointing-device based actions
> > > >that are unique to the product or content, the keyboard commands
> > > >must also be listed. Wherever commercially reasonable and logically
> > > >practicable, all keyboard shortcuts, commands, and navigation should
> > > >be documented in at least one centralized location.
> > > >
> > > >Version 5: (second proposal from Judy/Peter):Information about
> > > >keyboard shortcuts, including available keyboard commands and
> > > >keyboard navigation mechanisms, must be listed in centrally located
> > > >user documentation, and available in context-sensitive help.
> > > >
> > > >Eliminating one still leaves us with three versions. From there, I
> > > >will ask the committee to decide on two competing versions and from
> > > >there we can attempt to determine consensus on one or the other.
> > > >
> > > >Can you tell me what the key issues are? My last notes indicate that
> > > >Andi was working on this based on note from Judy. I assume this
> > > >involves WCAG harmonization, but I could be wrong.
> > > >
> > > >Thanks,
> > > >
> > > >Mike
> > > >
> > > >Mike Paciello<?xml:namespace prefix = o ns =
> > > >"urn:schemas-microsoft-com:office:office" />
> > > >
> > > >Founder & Principal, TPG
> > > >
> > > >Tel: +1 603.882.4122 ext 103
> > > >
> > > >Cell: +1 603.566.7713
> > > >
> > > >e-mail:
> > > <?mailto: = EMAIL ADDRESS REMOVED = > = EMAIL ADDRESS REMOVED =
> > > >
> > > >web: <http://www.paciellogroup.com/>>www.paciellogroup.com
> > > >
> > >
> > >
> > >

WebAIM is an initiative of:
Center for Persons with Disabilities (CPD) Utah State University