A master thesis from Aalborg University
Internal documentation in an Elucidative environment
Term
4. term
Education
Publication year
2000
Submitted on
2012-02-14
Abstract
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.
Documents
Colophon: This page is part of the AAU Student Projects portal, which is run by Aalborg University. Here, you can find and download publicly available bachelor's theses and master's projects from across the university dating from 2008 onwards. Student projects from before 2008 are available in printed form at Aalborg University Library.
If you have any questions about AAU Student Projects or the research registration, dissemination and analysis at Aalborg University, please feel free to contact the VBN team. You can also find more information in the AAU Student Projects FAQs.