The Computer Journal
Software engineering and Modula-2
Software engineering and Modula-2
A hypertext system for literate C++ programming
Journal of Object-Oriented Programming
ACM SIGDOC Asterisk Journal of Computer Documentation
Documentation threads - presentation of fragmented documentation
Nordic Journal of Computing
Reimagining literate programming
Proceedings of the 24th ACM SIGPLAN conference companion on Object oriented programming systems languages and applications
Hi-index | 0.00 |
The object-oriented programming paradigm improves the reusability of software considerably. Suitable documentation must be provided in order to facilitate software reuse, however. Extensive reuse of existing software components requires increased maintenance activity and hence enhances the importance of system documentation. An adequate scheme should help to achieve higher documentation quality.In this paper we provide a documentation scheme that aims to fulfill the documentation needs of both reusing and maintaining personnel. This scheme distinguishes among overview, external view, and internal view of both static and dynamic aspects of software components. The various views are described and illustrated by examples. The goal is to provide guidelines for writing documentation of object-oriented software systems and for evaluating the completeness of existing documentation.