What programmers really want: results of a needs assessment for SDK documentation

Authors:
Janet Nykaza;Rhonda Messinger;Fran Boehme;Cherie L. Norman;Matthew Mace;Manuel Gordon
Affiliations:
Learning Solutions Group, Inc., Portage, MI;Learning Solutions Group, Inc., Portage, MI;Rockwell FirstPoint Contact, Wood Dale IL;Bank One Corporation, Chicago, IL;Granite Solutions, Inc., Portage, MI;Gordon & Gordon, Westmount, QC, Canada
Venue:
Proceedings of the 20th annual international conference on Computer documentation
Year:
2002

Citing 0
Cited 13

Leveraging technology affinity: applying a common set of tools and practices to information development

Proceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information
Guidance through active concerns

eclipse '06 Proceedings of the 2006 OOPSLA workshop on eclipse technology eXchange
Mismar: A New Approach to Developer Documentation

ICSE COMPANION '07 Companion to the proceedings of the 29th International Conference on Software Engineering
Aiding evolution with concern-oriented guides

Proceedings of the 3rd workshop on Linking aspect technology and evolution
Automatically locating framework extension examples

Proceedings of the 16th ACM SIGSOFT International Symposium on Foundations of software engineering
Creating and evolving developer documentation: understanding the decisions of open source contributors

Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering
Leveraging usage similarity for effective retrieval of examples in code repositories

Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering
A field study of API learning obstacles

Empirical Software Engineering
Codelets: linking interactive documentation and example code in the editor

Proceedings of the SIGCHI Conference on Human Factors in Computing Systems
Synthesizing API usage examples

Proceedings of the 34th International Conference on Software Engineering
Development and application of a heuristic to assess trends in API documentation

Proceedings of the 30th ACM international conference on Design of communication
API documentation and software community values: a survey of open-source API documentation

Proceedings of the 31st ACM international conference on Design of communication
Detecting API documentation errors

Proceedings of the 2013 ACM SIGPLAN international conference on Object oriented programming systems languages & applications

Quantified Score

Hi-index	0.01

Visualization

Abstract

This paper steps the reader through a needs assessment of programmers that was conducted by instructional designers. The assessment's purpose was to identify what learning support programmers need and want to successfully use a new software development kit (SDK). The paper includes the challenges the researchers encountered, the questions asked and the responses, the types of individuals interviewed, and the conclusions reached from the research. Recommendations also are presented. Those responsible with developing documentation, training, and other learning support systems for programmers may find this assessment helpful. Marketing, product development and customer support people may also find value in learning more about the needs of this unique audience.