Variorum: a multimedia-based program documentation system

Conventional software documentation systems are mostly based on textual descriptions that explain or annotate the program´s source code. Because these systems rely solely on texts, it is difficult for program authors to describe the overall algorithm structures and detailed implementation techniques of the programs, especially those that require visual presentation. Variorum is one of the first, if not the first, software documentation systems that allows program authors to record the process of “walking through” their own code using multimedia technology, specifically text, audio and digital pen drawing. This approach greatly improves the interactivity and flexibility in the software documentation process, as well as the quality of resulting software implementation documentations. In addition, to broaden its applicability and to reduce the implementation complexity, Variorum is designed to inter-operate with WWW technology, in that the program source code files and their annotations are stored on Web servers and are directly accessible via commercial Web browsers. This paper describes the design and implementation of Variorum, as well as the results of a preliminary usability study with the current prototype