Article

An online help framework for web applications

Authors:

Dan Hyung LeeAuthors Info & Claims

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

Pages 176 - 180

https://doi.org/10.1145/1297144.1297179

Published: 22 October 2007 Publication History

Abstract

As the number of users using web-based applications increases, online help systems are required to provide appropriate information in multiple formats and accesses. Since users are dealing with various applications simultaneously so as to complete objectives and make daily decisions, it is necessary to provide anytime, anywhere help or tutorials. However, developing effective and efficient help systems on behalf of users is costly. As geographically distributed and multilingual users with minimal training or interruption have increased significantly, it has become a requirement to restructure help systems. In order to meet users' requirements and business challenges, it is necessary to restructure help systems to deliver training, documentation, and online help while taking into account nonfunctional requirements such as usability, time-to-market, quality and maintainability. In this paper we try to overcome such technical and economic constraints through single sourcing and content reuse, embrace as many users as possible by HTML-based help systems, and beef up help contents through unified and structural help system design. In addition, network pipe method for user feedback data collection and statistical analysis has been suggested as user feedback automation.

References

[1]

Abraham, L., Dyer, S., and Hackell, S. Guidelines for Writing HTML Help, In Proceedings of the SIGDOC Conference 2000, ACM Press, Boston, MA. 2000. 453--462.

Digital Library

[2]

Chamberland, L. Componentization of HTML-based Online Help, In Proceedings of the Sixteenth Annual International Conference on Computer Documentation, ACM, 1999. 165--168.

Digital Library

[3]

Comeau, J. M. and Milton P. A Window-based Help, Tutorial and Documentation System, In Proceedings of the SIGDOC Conference 1993, ACM Press, Waterloo, ON, Canada, 1993. 71--81.

Digital Library

[4]

Dicks, R. Integrating Online Help, Documentation, and Training, In Annual ACM Conference on Systems Documentation, 1994. 115--118.

Digital Library

[5]

Foster, G. Online Help Systems: Learning while Working, In Proceedings of the International Conference on Computers in Education, IEEE Computer Society, 2002.

Digital Library

[6]

Green R., Component-Based Software Development: Implications for Documentation, In Proceedings of the 17th Annual International Conference on Computer Documentation, 1999. 159--164.

Digital Library

[7]

Hopkins, J. S. and Jernow, J. M. Documenting the Software Development Process, In Proceedings of the SIGDOC Conference 1990, ACM Press, Pittsburgh, PA. 1990. 125--133.

Digital Library

[8]

Huang, S. and Tilley, S. Towards a Documentation Maturity Model. In Proceedings of the SIGDOC Conference 2003, ACM Press, San Francisco, CA. 2003. 93--99.

Digital Library

[9]

Juran, J. M. Quality Control Handbook, McGraw-Hill, New York, 1988.

[10]

Kantner, L. and Rusinsky L. Designing a Winhelp Project for Quick Conversion to Lowest-Common-Denominator HTML-Based Help: A Case Study, In Proceedings International Conference of Computer Documentation, 1998. 214--218.

Digital Library

[11]

Kenneth, O. Implementing a Large Scale Windows Help System: Critical Success Factors and Lessons Learned, In Proceedings of the SIGDOC Conference 2000, ACM Press, Boston, MA. 2000. 106--115.

Digital Library

[12]

Knight, G. and Kilis, D. and Cheng, P. An Architecture for an Integrated Active Help System, In Proceedings of the 1997 ACM Symposium on Applied Computing, San Jose, CA, 1997, 58--64.

Digital Library

[13]

Kramer, D. API Documentation from Source Code Comments: A Case Study of Javadoc, In Proceedings of the 17th Annual International Conference on Computer Documentation, New Orleans, LA, 1999, 147--153.

Digital Library

[14]

Magyar, M. Automating Software Documentation: A Case Study, In Proceedings of the SIGDOC Conference 2000, ACM Press, Boston, MA. 2000. 549--558.

Digital Library

[15]

Mamone, S. Documentation Testing, ACM SIGSOFT Software Engineering Notes, 25(2) 2000. 26--29.

Digital Library

[16]

Mandel, T. Quality Technical Information: Paving the Way for Usable Print and Web Interface Design, ACM Journal of Computer Documentation, 26(3), 2002. 118--125.

Digital Library

[17]

Meyer, O. aTool - Creating Validated XML Documents on the Fly Using MS Word, In Proceedings of the SIGDOC Conference 2002, ACM Press, Toronto, ON. 2002. 113--121.

Digital Library

[18]

Patrick, A. and McGurgan, A. One Proven Methodology for Designing Robust Online Help Systems, In Proceedings of the 11th Annual International Conference on Systems Documentation, Waterloo, ON. Canada, 1993. 223--232.

Digital Library

[19]

Ramey, J. and Miler, M., High-tech Publications Need Old-Fashioned Editing, In Proceedings of the SIGDOC Conference 2000, ACM Press, Boston, MA. 2000. 145--154.

Digital Library

[20]

Rintjema, L. and Warburton, K. Creating an HTML Help System for Web-based Products, In Proceedings of the 16th Annual International Conference on Computer Documentation, Quebec, CA, 227--233. 1998.

Digital Library

[21]

Selvidge P. R., Chaparro B. S. and Bender G. T., The World Wide Wait: Effects of Delays on User Performance, International Journal of Industrial Ergonomics, 29(1) 2002. 15--20.

[22]

Sen A., Dacin P. A., Pattichis C., Current Trends in Web Data Analysis, Communications of the ACM, 49(11) 2006 85--91.

Digital Library

[23]

Sleeter, M. E. OpenDoc - Building Online Help for a Component-Oriented Architecture, In Proceedings of the SIGDOC Conference 1996, ACM Press, Research Triangle Park, NC. 1996. 87--94.

Digital Library

[24]

Smart, K. L. Accessing Quality Documents, ACM Journal of Computer Documentation, 26(3) 2002. 130--140.

Digital Library

[25]

Smart, K. and Whiting, M. Reassessing the Documentation Paradigm: Writing for Print and Online, In Proceedings of the 12th Annual International Conference on Systems Documentation, Banff, Alberta, 1994. 6--9.

Digital Library

[26]

Souza S., Anquetil, N. and Oliveira K., A Study of the Documentation Essential to Software Maintenance, In Proceedings of the SIGDOC Conference 2005, ACM Press, Coventry, UK. 68--75, 2005.

Digital Library

[27]

Stimely, G. L. A Stepwise Approach to Developing Software Documentation, In Proceedings of the SIGDOC Conference 1990, ACM Press, Little Rock, AR. 121--124, 1990.

Digital Library

[28]

Tsuji, S. and Yamamoto, Y. A Framework to Provide Integrated Online Documentation, In Proceedings of the SIGDOC Conference 2001, ACM Press, Santa Fe, NM. 185--192, 2001.

Digital Library

[29]

Wentorf, D. Printed Pages vs. Web Pages: The Documentation Dilemma, In Proceedings of the 29th Annual ACM SIGUCCS Conference on User Services, Portland, OR. 204--209, 2001.

Digital Library

Cited By

Carroll JRosson M(2014)Usability EngineeringComputing Handbook, Third Edition10.1201/b16768-38(32-1-32-22)Online publication date: May-2014
https://doi.org/10.1201/b16768-38
Hayashi EBaranauskas MShin SOssowski SSchumacher MPalakal MHung C(2010)Understanding meta-communication in an inclusive scenarioProceedings of the 2010 ACM Symposium on Applied Computing10.1145/1774088.1774343(1213-1218)Online publication date: 22-Mar-2010
https://dl.acm.org/doi/10.1145/1774088.1774343

Index Terms

An online help framework for web applications
1. Software and its engineering
  1. Software creation and management
    1. Software post-development issues
      1. Documentation

Recommendations

Expressing help at appropriate levels
SIGDOC '08: Proceedings of the 26th annual ACM international conference on Design of communication

Users of help systems often complain that the documentation is pitched at the wrong level, but the "right" level differs among users. Building on a prior definition of the space of possible expressions of documentation in terms of task, application, and ...
A multi-site field study of crowdsourced contextual help: usage and perspectives of end users and software teams
CHI '13: Proceedings of the SIGCHI Conference on Human Factors in Computing Systems

We present a multi-site field study to evaluate LemonAid, a crowdsourced contextual help approach that allows users to retrieve relevant questions and answers by making selections within the interface. We deployed LemonAid on 4 different web sites used ...
Search Engines' Help Systems
ITNG '08: Proceedings of the Fifth International Conference on Information Technology: New Generations

The HELP information provided by search engines can facilitate its user’s information seeking process or hinder it. This study analyzed 20 search engines on how their HELP Systems are placed and organized. Help systems are separated into pre-search help ...

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

October 2007

286 pages

ISBN:9781595935885

DOI:10.1145/1297144

General Chair:
David Novick
The University of Texas at El Paso, TX
,
Program Chair:
Clay Spinuzzi
The University of Texas at Austin, TX

Copyright © 2007 ACM.

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Sponsors

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 22 October 2007

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

SIGDOC07

Sponsor:

SIGDOC07: The 25th ACM International Conference on Design of Communication

October 22 - 24, 2007

Texas, El Paso, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

2
Total Citations
View Citations
689
Total Downloads

Downloads (Last 12 months)0
Downloads (Last 6 weeks)0

Reflects downloads up to 01 Mar 2025

Other Metrics

View Author Metrics

Citations

Cited By

Carroll JRosson M(2014)Usability EngineeringComputing Handbook, Third Edition10.1201/b16768-38(32-1-32-22)Online publication date: May-2014
https://doi.org/10.1201/b16768-38
Hayashi EBaranauskas MShin SOssowski SSchumacher MPalakal MHung C(2010)Understanding meta-communication in an inclusive scenarioProceedings of the 2010 ACM Symposium on Applied Computing10.1145/1774088.1774343(1213-1218)Online publication date: 22-Mar-2010
https://dl.acm.org/doi/10.1145/1774088.1774343

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Figures

Tables

Media

View Table of Conten