Sylvia B. Sheppard
ABSTRACT
The success of any software development project depends in part on the quality of the communication among the individuals involved: users, designers, coders and managers. On large systems, a variety of individuals perform various tasks at different points in time. The efficiency and correctness with which later tasks are performed depends critically on the documentation supplied during previous phases of the development cycle. This paper describes a series of three experiments designed to examine the effects of documentation format on the performance of programmers on different software-related tasks.
- 1.Blaiwes, A.S. Formats for presenting procedural instructions. Journal of Applied Psychology, 1974, 59, 683-686.Google Scholar
Cross Ref
- 2.Jones, C. A survey of programming design and specification techniques. In Proceedings of the IEEE Conference on Specifications of Reliable Software. New York: Institute of Electrical and Electronics Engineers, 1979.Google Scholar
- 3.Kammann, R. The comprehensibility of printed instructions and the flowchart alternative. Human Factors, 1975, 17, 183-191.Google ScholarCross Ref
- 4.Kirk, R.E. Experimental design procedures for the behavioral sciences. Belmont, CA: Brooks-Cole, 1968.Google Scholar
- 5.Miller, L.A. Natural language programming: styles, strategies, and contrasts. IBM Systems Journal, 1981, 20, 184-215.Google ScholarDigital Library
- 6.Ramsey, H.R., Atwood, M.E., & Van Doren, J.R. A comparative study of flowcharts and program design language for the detailed procedural specification of computer programs. (Tech. Rep. #SAI-78-078-DEN). Denver: Science Applications, Inc. 1978.Google Scholar
- 7.Shneiderman, B., Mayer, B.R., McKay, D., & Heller, P. Experimental investigations on the utility of detailed flowcharts in programming. Communications of the ACM, 1977, 20, 373-381. Google ScholarDigital Library
- 8.Winer, B.J. Statistical principles in experimental design. New York: McGraw-Hill, 1971.Google Scholar
- 9.Wright, P. & Reid, F. Written information: Some alternatives to prose for expressing the outcomes of complex contingencies. Journal of Applied Psychology, 1973, 57, 160-166.Google ScholarCross Ref
Index Terms
- An empirical evaluation of software documentation formats
Recommendations
Knowledge-based approaches in software documentation: A systematic literature review
Context: Software documents are core artifacts produced and consumed in documentation activity in the software lifecycle. Meanwhile, knowledge-based approaches have been extensively used in software development for decades, however, the software ...
Software maintenance documentation
SIGDOC '89: Proceedings of the 7th annual international conference on Systems documentationWhen technical writers speak of software documentation, they usually speak of user manuals. Certainly there is reason for them to. User manuals produced by software people (and I am proud to count myself as a software person!) have often been so bad ...
Comments