Program documentation at Wichita State University
Authors
Advisors
Issue Date
Type
Keywords
Citation
Abstract
The main purpose of this paper is to discuss program documentation and propose solutions to the problems associated with it.. It has been widely recognized that formal documentation of computer systems has been a major problem for computer users because it is sometimes inaccurate, oftentimes incomplete, and occasionally even missing. This failure to adequately document software has led to higher productio1~ and maintenance costs, customer dissatisfaction and the development of useless programs. In a move to avoid these problems, the Computer Science Department at WSU has established a standard for program submittal in all its classes with laboratories. This standard also promotes good programming practices, such as designing before coding and modularization, provides our students with a disciplined approach, orients them to what industry requires and facilitates the grading of their programming assignments. The standard is introduced in CS200, Introduction to Programming, in which the focus is problem analysis and the writing of the solution in pseudocode. This standard was mplemented in August, 1979, along with a new computer science program that was based on the Curriculum 78 guidelines. Since that time the standard, which was origiginally ally developed by then-faculty Don Newman and Steve Taylor, has undergone a few revisions and was updated most recently by Peggy Wright, a computer science graduate student.