best practices for embedded user assistance -...

19
Best Practices for Embedded User Assistance Scott DeLoach tt@ li k t t t scott@clickstart.net Founder, ClickStart Certified Instructor, Flare | RoboHelp | Captivate Author, MadCap Flare for RoboHelp Users © 2007 ClickStart, Inc. All rights reserved. Overview Why embedded UA is effective Integrating embedded UA with external help Best practice examples Dynamic user assistance

Upload: dothuan

Post on 07-Jul-2018

224 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Best Practices for Embedded User Assistance

Scott DeLoachtt@ li k t t [email protected]

Founder, ClickStartCertified Instructor, Flare | RoboHelp | CaptivateAuthor, MadCap Flare for RoboHelp Users

© 2007 ClickStart, Inc. All rights reserved.

Overview

Why embedded UA is effective Integrating embedded UA with external helpBest practice examplesDynamic user assistance

Page 2: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Embedded UA is effective

Fact: Users will not request help or even hints, even after making multiple mistakes.- Aleven, V., McLaren, B. M., & Koedinger, K.R. (2006). Towards computer-, , , , g , ( ) pbased tutoring of help-seeking skills. in Help Seeking in Academic Settings: Goals, Groups, and Contexts, Lawrence Erlbaum, San Francisco.

Fact: Users don’t see embedded UA as "help."- Grayling, T. (2002). A usability test of two browser-based embedded

help systems. Journal of the Society of Technical Communication49(2):193-209.

Fact: Users use embedded help.- Martin, A. P., Ivory, M. Y., Megraw, R., & Slabosky, B. (2005). Exploring the

persistent problem of user assistance. Technical Report IS-TR-2005-08-01. University of Washington Information School.

Combining embedded UA and external help

Context-sensitive

Functional UA (field labels)

external help links

Page 3: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Combining embedded UA and help

Display options

Page overviews

Field labels

DHTML popups

Popup windows

UA panels

Page 4: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Page overviews

Best for answering…

Conceptual (‘Why is this important?’) questions

Pro

Appear in a prominent position, so they are more likely to be read

ConCon

Usually ignored if longer than ~2 sentences

Page overviews

Med Assets InSource

Page 5: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Page overviews

Field labels

Best for answering…

Functional (‘What is this?’) questions

Pro

Very useful and easy to use

Cons

Do not scale well to support all fieldsDo not scale well to support all fields

Very limited amount of information

Page 6: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Field labels

eloan.com

Field labels - error messages

bankofamerica.com

Page 7: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

DHTML popups

Best for answering…

Conceptual questions

Pros

Can include a large amount of information

Save space by layering information

CCons

Usually cannot include links

Must be "found" by users

Opener can be confused with a hyperlink

DHTML popups - definitions

fueleconomy.gov

Page 8: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

DHTML popups - definitions

iconmovies.co.uk/starterforten

DHTML popups - definitions

tonikhealth.com

Page 9: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

DHMTL popups – multiple definitions

dodge.com

DHTML popups – examples

msdn.microsoft.com

Page 10: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

DHTML popups – procedures

USPS (in post office)

Popup windows

Best for answering…

Conceptual questions

Pros

Can use a HAT to develop topics

Can include links and navigation

Can include an "unlimited" amount of information

Con

Often obscure application window

Page 11: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Popup windows

apple.com

Best for answering…

Conceptual and procedural questions

UA panels

Pros

Can include a large amount of information

Very easy to use - user doesn’t have to ask for help

ConCon

Difficult to add to an existing application

Page 12: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

UA panels

ebay.com

UA panels

bankofamerica.com

Page 13: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

UA panels

alamo.com

Dynamic help

Link previews

Highlight definition popups

Customizable UA

Page 14: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

DHTML popups – link previews

nationmaster.com

DHTML popups – link previews (AJAX)

netflix.com

Page 15: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Popup windows - highlight definitions

CheckFree RightCare

Popup windows - highlight definitions

CheckFree RightCare

Page 16: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Customizable UA (AJAX)

backbase.com/demos/examples

Customizable UA (AJAX)

Page 17: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Customizable UA (AJAX)

Customizable UA (AJAX)

Page 18: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Best practices

Provide information at the point of use

Write topics to answer user questions

Combine embedded UA with external help

Provide focused help links ('Tell me more,' 'Tips,' 'Why?')

Example embedded UA sites

alamo.com

apple.com

fueleconomy.gov

iconmovies.co.uk/starterforten

bankofamerica.com

dodge.com

ebay.com

eloan.com

monster.com

msdn.microsoft.com

nationmaster.com

netflix.com

Page 19: Best Practices for Embedded User Assistance - ClickStartclickstart.net/presentations/embeddedua_writersua07.pdf · Best Practices for Embedded User Assistance Scott DeLoach ... Migrating

Questions?

Send me an e-mail, and I’ll be glad to help.

Scott DeLoachFounder, ClickStart

Certified Instructor, Flare | RoboHelp | Captivate

Author, MadCap Flare for RoboHelp Users

[email protected] 520 0003404.520.0003www.clickstart.net

About ClickStart

ClickStart provides certified training and consulting for:MadCap FlareAdobe RoboHelpAdobe Captivate

We offer public, online, and private (onsite) classes, and group discounts are available. See www.clickstart.net for more information.

If you need help:Learning Flare, RoboHelp, or CaptivateMigrating to Flare from RoboHelp or another productDesigning stylesheets for online helpCreating use cases and wireframes/prototypesDeveloping Web-based trainingAdding embedding user assistance or context-sensitive help to an application

Give us a call: 404.520.0003