skip to main content
10.1145/1166324.1166346acmconferencesArticle/Chapter ViewAbstractPublication PagesdocConference Proceedingsconference-collections
Article

What users say they want in documentation

Published: 18 October 2006 Publication History

Abstract

While earlier work provided a partial view of users' preferences about manuals, for most users in most work contexts the important question remains open: What do users want in documentation? This paper presents the results of a study in which a diverse cross-section of 25 users was interviewed in depth about their needs and preferences with respect to software help systems, whether printed or on-line, that they use at work. The study's participants indicated that they preferred documentation, whether online or printed, that is easy to navigate, provides explanations at an appropriate level of technical detail, enables finding as well as solving problems through examples and scenarios, and is complete and correct. These preferences give rise to difficult issues, including a possibly inherent tension between coverage and precision, and variation among users with respect to desired level of technical complexity of explanation

References

[1]
Ceaparu, I., Lazar, J., Bessiere, K., Robinson, J., and Shneiderman, B. (2004). Determining causes and severity of end-user frustration, International Journal of Human-Computer Interaction, 17(3), 333--356.
[2]
Frøkjær, E., Hertzum, M., and Hornbæk, K. (2000). Measuring usability: Are effectiveness, efficiency and satisfaction really correlated? Proceedings of CHI 2000, The Hague, NL, April, 2000, 345--352.
[3]
Martin, A., Ivory, M., Megraw, R., and Slabosky, B. (2005). Exploring the persistent problem of user assistance. Technical Report IS-TR-2005-08-01, Information School, University of Washington.
[4]
Mendoza, V. and Novick, D. (2005). Usability over time, Proceedings of SIGDOC 2005, Coventry, UK, September, 2005, 151--158.
[5]
Mitchell, G. (1993). What do users really want from computer documentation? Proceedings of IPCC 93, Philadelphia, PA, October, 1993, 27--31.
[6]
Novick, D. and Ward, K. (in press). Why don't people read the manual? Proceedings of SIGDOC 2006, Myrtle Beach, SC, October, 2006.
[7]
Rettig, M. (1991). Nobody reads documentation, Communications of the ACM, 34(7), July, 1991, 19-24.
[8]
Schober, M. F. and Clark, H. H. (1989). Understanding by addressees and overhearers, Cognitive Psychology, 21, 211--232.
[9]
Smart, K., Whiting, M., and De Tienne, K (2001). Assessing the need for printed and online documentation: A study of customer preference and use, Journal of Business Communication 38(3), 285--314.

Cited By

View all

Recommendations

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences
SIGDOC '06: Proceedings of the 24th annual ACM international conference on Design of communication
October 2006
224 pages
ISBN:1595935231
DOI:10.1145/1166324
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: 18 October 2006

Permissions

Request permissions for this article.

Check for updates

Author Tags

  1. help systems
  2. user preferences
  3. user requirements

Qualifiers

  • Article

Conference

SIGDOC06
Sponsor:

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

  • Downloads (Last 12 months)31
  • Downloads (Last 6 weeks)3
Reflects downloads up to 18 Feb 2025

Other Metrics

Citations

Cited By

View all
  • (2024)Exploring behaviours of RESTful APIs in an industrial settingSoftware Quality Journal10.1007/s11219-024-09686-032:3(1287-1324)Online publication date: 1-Sep-2024
  • (2024)Exploring API behaviours through generated examplesSoftware Quality Journal10.1007/s11219-024-09668-232:2(729-763)Online publication date: 1-Jun-2024
  • (2023)A uniqueness-based approach to provide descriptive JUnit test namesJournal of Systems and Software10.1016/j.jss.2023.111821205(111821)Online publication date: Nov-2023
  • (2023)React example viability for efficient API learning (REVEAL): A tool to help programmers utilize incompatible code examples in React.jsJournal of Computer Languages10.1016/j.cola.2023.10120175(101201)Online publication date: Jun-2023
  • (2020)Automatic Detection and Repair Recommendation of Directive Defects in Java API DocumentationIEEE Transactions on Software Engineering10.1109/TSE.2018.287297146:9(1004-1023)Online publication date: 1-Sep-2020
  • (2020)Including Human Factors and Ergonomics in Requirements Engineering for Digital Work Environments2020 IEEE First International Workshop on Requirements Engineering for Well-Being, Aging, and Health (REWBAH)10.1109/REWBAH51211.2020.00013(57-66)Online publication date: Aug-2020
  • (2020)An Empirical Investigation into the Effects of Code Comments on Issue Resolution2020 IEEE 44th Annual Computers, Software, and Applications Conference (COMPSAC)10.1109/COMPSAC48688.2020.0-150(921-930)Online publication date: Jul-2020
  • (2018)Neural-machine-translation-based commit message generation: how far are we?Proceedings of the 33rd ACM/IEEE International Conference on Automated Software Engineering10.1145/3238147.3238190(373-384)Online publication date: 3-Sep-2018
  • (2018)An Investigation of Maintenance Technicians’ Information-Seeking Behavior in a Repair CenterIEEE Transactions on Professional Communication10.1109/TPC.2018.282608761:3(257-274)Online publication date: Sep-2018
  • (2017)API usage in descriptions of source code functionalityProceedings of the 1st International Workshop on API Usage and Evolution10.5555/3106028.3106032(3-6)Online publication date: 20-May-2017
  • Show More Cited By

View Options

Login options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Figures

Tables

Media

Share

Share

Share this Publication link

Share on social media