More on embedded Help

Documentation that is integrated into a product's user interface is known as "embedded help" or "UI text." This is often the most effective form of documentation because it isn't abstracted from the user's actions. It literally provides another layer of interface, albeit one that is overtly instructional and (typically) textual in implementation.

It's best when UI text is planned-in from the beginning of a project, but doing so can result in its overuse. If there's too much of it, it clutters the interface and is likely to be ignored.

For more on embedded Help, see DevShed's "The Importance of Interface Text" (thanks The Creative Tech Writer.) and "Exploring Embedded Help."

Posted: November 23, 2003 link to this item, Tweet this item, respond to this item