Documentation:Visibly Discernible

Documentation > Visibly Discernible Landmarks

When products have visibly discernible landmarks, how should these be included in the documentation?

This page is being split into two sections; responses to the issue then additional questions with responses.

A draft "best practice" for this topic was added to the April working drafts page

Responses to the issue.

Comment from Jim Tobias:

Important! How about a standard that says if there is a diagram of the product, then there should be a corresponding description of the physical layout.

Comment from David Baquis:

I am reminded of a NCAM SALT guideline also addressing that issue:

"Finally, documentation and training materials are always more accessible when: Documentation and online help can be understood independent of graphics. Text descriptions should stand on their own."

See IMS Guidelines for Developing Accessible Learning Applications: http://ncam.wgbh.org/salt/guidelines/sec2.html

I found those guidelines very helpful, and they could be informative to other TEITAC subcommittees as well.

Items from March 8, 2007 discussion:

Also include name of the tool bar/window instead of just saying the upper left box on the window.

There are also mouse keys to get to the upper left corner.

Web sites with good structure, but the CSS change how the page works.

Additional questions:

None raised at this time.