Internal documentation in an Elucidative environment

Student thesis: Master thesis (including HD thesis)

  • Max Rydahl Andersen
  • Kristian Lykkegaard Sørensen
  • Claus Nyhus Christensen
4. term, Computer Science, Master (Master Programme)
This master thesis deals with the structure and history of internal documentation in an elucidative environment.
Internal documentation is documentation which is produced by developers, used by developers and which documents the internal structures, such as algorithms or data structures of software.
Three main contributions are presented in the thesis: (1) The formulation of a documentation model, called the MRS-model, which divides the internal documentation into three interrelated categories: Motivations, Rationales and Solution descriptions. (2) A practical implementation of the MRS-model in an elucidative environment. (3) By using the MRS-model, a method is sketched for documenting the history of internal documentation and source code as a natural part of the internal documentation.
Based on these three contributions the report concludes that the structure of the MRS-model is both beneficial to the internal documentation and improves the presentation of the documentation to the reader. Furthermore it is concluded that the history of software can be documented, and be a natural part of the internal documentation.
LanguageEnglish
Publication dateJun 2000
ID: 61079511