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?
Interactivity - shortcut buttons - troubleshooting - product tours - Performance support Provide alternate interface(s) Easier to use Advantages of Embedded Help
Small Help area Lacks structure (TOCs, Index) Printing problems Harder to create and implement Disadvantages of Embedded Help
Example 1: Designing for Compatibility App/Site: Ceridian Empowerment Specs: Works any browser Uses JavaScript Does not use DHTML or CSS
Context-sensitivity (draft icons) Screen-level Help provides a summary of the screen and links to related task topics.
Context-sensitivity 1 How it works JavaScript code: determines the current page (currentpage.htm) loads Help file as h_currentpage.htm 2
Active Assistance Help text automatically changes when the user moves to a different field.
Active Assistance JavaScript code: receives the form elements name (bDate) shows the Help file (h_bDate.htm) 2 How it works 1
Progress Tracking Task topics monitor your progress with the arrow and mark skipped steps.
Progress Tracking JavaScript code: receives the form element or pages 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
Cross-browser Help System JavaScript-based TOC and CGI-based search work with older browsers on virtually any platform.
Tools Dreamweaver (embedded Help) Notepad (JavaScript js file) RoboHELP HTML (Help system) Technologies JavaScript frames Tools and Technologies
Example 2: Fully Integrated Assistance App/Site: MySample.com Specs: Works in IE 4+ and Netscape 4+ Uses JavaScript Uses DHTML and CSS
Window Overviews and Tips
Enhanced Hover Help
How it works onMouseOver="helpSHOW(this.title)" onMouseOut="helpHIDE(this.title)" 1 JavaScript code shows and hides the requested layer. 2
Tools Dreamweaver (embedded Help) Notepad (JavaScript js file) RoboHELP HTML (Help system) Technologies JavaScript DHTML and CSS Tools and Technologies
Example 3: Automatic Assistance App/Site: Alamo.com Specs: Works in IE 4+ and Netscape 4+ Uses JavaScript Uses DHTML and CSS
Automatic Assistance Helpful Information automatically changes as different fields receive focus.
Tools HTML Editor Technologies JavaScript DHTML and CSS Tools and Technologies
Example 4: Focusing on Tasks App/Site: eBay Specs: Works in IE 4+ and Netscape 4+ Uses JavaScript Uses DHTML and CSS
Show me how icon is available for every eBay item. Modular Task-based Tutorial
Simple introduction and overview of the bidding tutorial. Modular Task-based Tutorial
Tutorial includes real information based on the item (in this case, the actual current bid rather than a static number). Modular Task-based Tutorial
How it works Hidden layer with CGI-generated price. 1 JavaScript code shows and hides the requested layer. 2
Tools Dreamweaver (prototyping) Technologies JavaScript DHTML CGI Tools and Technologies
Example 5: Focusing on Performance App/Site: US Postal Service POS1 Specs: Works in any browser Designed for use without a mouse Uses JavaScript
High-volume Retail Application
Quick Procedural Information Help appears when user presses Help on customized keyboard.
Tools Notepad Technologies HTML JavaScript Tools and Technologies
HTML Dynamic HTML (DHMTL) Cascading Style Sheets (CSS) JavaScript Document Object Model (DOM) What do I need to know?
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. Its the best resource for answering syntax and browser compatibility questions. Recommended JavaScript Books
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 Explorerand theres a lot it can do!this is the book for you. Recommended DHTML Books
Feel free to me. Or, catch me later at the conference! Scott DeLoach Founding Partner, User First Services, Inc. Certified RoboHELP Instructor and Consultant Questions?