• DocumentCode
    3534582
  • Title

    Literate programming and documentation reuse

  • Author

    Childs, Bart ; Sametinger, Johannes

  • Author_Institution
    Dept. of Comput. Sci., Texas A&M Univ., College Station, TX, USA
  • fYear
    1996
  • fDate
    23-26 April 1996
  • Firstpage
    205
  • Lastpage
    214
  • Abstract
    Object-oriented programming has brought many advantages to the software engineering community. The reuse of existing software components and application frameworks can improve the productivity in software development considerably. The same object-oriented techniques, i.e., inheritance and information hiding, that ease reusing software, can be applied to documentation and thus, enable its reuse. One can document each software component-regardless of what a component is-from scratch. This leads to multiple documentation of features that are multiply reused. One can also describe a component´s differences to other components. This seems logical for the systems documentation of object-oriented software. However, as is shown, this kind of reuse can not only be applied to source-code related documentation, but also to documentation, where there is no source code involved at all, e.g., user documentation. We describe the concepts for documentation reuse, how these concepts can be realized with a literate programming tool, and the application of documentation reuse.
  • Keywords
    human resource management; inheritance; object-oriented programming; software reusability; software tools; system documentation; documentation reuse; information hiding; inheritance; literate programming; literate programming tool; multiple documentation; object-oriented programming; object-oriented software; productivity; software engineering; software reuse; source-code related documentation; systems documentation; user documentation; Application software; Computer science; Documentation; Object oriented programming; Productivity; Programming profession; Shape; Software engineering; Software libraries; Software maintenance;
  • fLanguage
    English
  • Publisher
    ieee
  • Conference_Titel
    Software Reuse, 1996., Proceedings Fourth International Conference on
  • Conference_Location
    Orlando, FL, USA
  • Print_ISBN
    0-8186-7301-X
  • Type

    conf

  • DOI
    10.1109/ICSR.1996.496128
  • Filename
    496128