Top Banner
Designing Embedded User Assistance for Web-based Applications Scott DeLoach
36

Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Mar 27, 2015

Download

Documents

Ryan Scott
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Designing Embedded User Assistance for Web-

based Applications

Scott DeLoach

Page 2: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Help that appears in the application rather than in a separate Help window.

Examples:- Microsoft Money- HTML Help Workshop- HomeSite

What is Embedded Help?

Page 3: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Interactivity- shortcut buttons- troubleshooting- product tours- Performance support

Provide alternate interface(s) Easier to use

Advantages of Embedded Help

Page 4: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Small Help areaLacks structure (TOCs, Index)Printing problemsHarder to create and implement

Disadvantages of Embedded Help

Page 5: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Example 1:

Designing for Compatibility

App/Site: Ceridian Empowerment

Specs:Works any browserUses JavaScriptDoes not use DHTML or CSS

Page 6: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Context-sensitivity(draft icons)

Screen-level Help provides a summary of the screen and links to related task topics.

Page 7: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Context-sensitivity

1

How it works

JavaScript code:• determines the current page (currentpage.htm)• loads Help file as h_currentpage.htm

2

Page 8: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Active Assistance

Help text automatically changes when the user moves to a different field.

Page 9: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Active Assistance

JavaScript code:

• receives the form element’s name (bDate)

• shows the Help file (h_bDate.htm)

2

<input name=”bDate" size="11" maxlength="10" onfocus="helpkey(this)" onblur="helpkey()”>

How it works

1

Page 10: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Progress Tracking

Task topics monitor your progress with the arrow and mark skipped steps.

Page 11: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Progress Tracking

<input name=”mStatus" size="11" maxlength="10" onchange="helptaskform(this)">

JavaScript code:

• receives the form element or page’s name

• finds a match in the step list

• moves the arrow to the step

3<BODY TEXT="000000" BGCOLOR="ffffff" onload="helptask();">

1

How it works

2

Page 12: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Cross-browser Help System

JavaScript-based TOC and CGI-based search work with older browsers on virtually any platform.

Page 13: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

ToolsDreamweaver (embedded Help)Notepad (JavaScript “js” file)RoboHELP HTML (Help system)

Technologies JavaScriptframes

Tools and Technologies

Page 14: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Example 2:

Fully Integrated Assistance

App/Site: “MySample.com”

Specs:Works in IE 4+ and Netscape 4+Uses JavaScript Uses DHTML and CSS

Page 15: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Window Overviews and Tips

Page 16: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Window Overviews and Tips

Page 17: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Enhanced “Hover Help”

Page 18: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Enhanced “Hover Help”How it works

onMouseOver="helpSHOW(this.title)" onMouseOut="helpHIDE(this.title)"

1

JavaScript code shows and hides the requested layer.

2

Page 19: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

ToolsDreamweaver (embedded Help)Notepad (JavaScript “js” file)RoboHELP HTML (Help system)

Technologies JavaScriptDHTML and CSS

Tools and Technologies

Page 20: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Example 3:

Automatic Assistance

App/Site: “Alamo.com”

Specs:Works in IE 4+ and Netscape 4+Uses JavaScript Uses DHTML and CSS

Page 21: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Automatic Assistance

“Helpful Information” automatically changes as different fields receive focus.

Page 22: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

ToolsHTML Editor

Technologies JavaScriptDHTML and CSS

Tools and Technologies

Page 23: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Example 4:

Focusing on Tasks

App/Site: eBay

Specs:Works in IE 4+ and Netscape 4+Uses JavaScript Uses DHTML and CSS

Page 24: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

“Show me how” icon is available for every eBay item.

Modular Task-based Tutorial

Page 25: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Simple introduction and overview of the bidding tutorial.

Modular Task-based Tutorial

Page 26: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Tutorial includes real information based on the item (in this case, the actual current bid rather than a static number).

Modular Task-based Tutorial

Page 27: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Modular Task-based TutorialHow it works

Hidden layer with CGI-generated price.1

JavaScript code shows and hides the requested layer.

2

Page 28: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

ToolsDreamweaver (prototyping)

Technologies JavaScriptDHTMLCGI

Tools and Technologies

Page 29: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Example 5:

Focusing on Performance

App/Site: US Postal Service POS1

Specs:Works in any browserDesigned for use without a mouseUses JavaScript

Page 30: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

High-volume Retail Application

Page 31: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Quick Procedural Information

Help appears when user presses “Help” on customized keyboard.

Page 32: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

ToolsNotepad

TechnologiesHTML JavaScript

Tools and Technologies

Page 33: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

HTMLDynamic HTML (DHMTL) Cascading Style Sheets (CSS) JavaScriptDocument Object Model (DOM)

“What do I need to know?”

Page 34: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Heinle, Nick. Designing with JavaScript. A great introduction to JavaScript.

Holzner, Steven. JavaScript Complete.This book focuses on version 4+ browsers and provides good information about Dynamic HTML.

Goodman, Danny. JavaScript Bible.An excellent reference book. It’s the best resource for answering syntax and browser compatibility questions.

Recommended JavaScript Books

Page 35: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Schurman, Eric. Dynamic HTML in Action.Great introduction to HTML and DHTML.

Goodman, Danny. Dynamic HTML: The Definitive Reference.A handy reference, especially if you are developing cross-platform embedded Help.

Microsoft Press. DHTML Reference and SDK. Comprehensive reference book. If you need to know everything about DHTML in Internet Explorer—and there’s a lot it can do!—this is the book for you.

Recommended DHTML Books

Page 36: Designing Embedded User Assistance for Web- based Applications Scott DeLoach.

Feel free to e-mail me. Or, catch me later at the conference!

Scott DeLoachFounding Partner, User First Services, Inc.Certified RoboHELP Instructor and [email protected]

Questions?