A Model for Structuring User Documentation of Object-Oriented Frameworks Using Patterns and Hypertext

Adequate documentation of an object-oriented framework is the prerequisite to its success as a reusable component. The overall design of a framework and its intended method of reuse are not obvious from the source code and thus have to be addressed in the documentation. Most importantly, the documentation of a framework has to be structured in such a way that it guarantees the adequate support of three major audiences: users selecting a framework, users learning to develop typical applications based on the selected framework, and users intending to modify its architecture.

[1]  Dennis B. Smith,et al.  Towards a framework for program understanding , 1996, WPC '96. 4th Workshop on Program Comprehension.

[2]  Roy H. Campbell,et al.  A technique for documenting the framework of an object-oriented system , 1992, [1992] Proceedings of the Second International Workshop on Object Orientation in Operating Systems.

[3]  Ian M. Holland,et al.  Contracts: specifying behavioral compositions in object-oriented systems , 1990, OOPSLA/ECOOP '90.

[4]  Kim Mens,et al.  Vrije Universiteit Brussel Faculteit Wetenschappen Reuse Contracts: Managing the Evolution of Reusable Assets Reuse Contracts: Managing the Evolution of Reusable Assets , 2022 .

[5]  Jong-Deok Choi,et al.  Slicing class hierarchies in C++ , 1996, OOPSLA '96.

[6]  James D. Arthur,et al.  A Taxonomy for the Evaluation of Computer Documentation , 1988 .

[7]  Cláudia Maria Lima Werner,et al.  Packaging reusable components using patterns and hypermedia , 1996, ICSR.

[8]  D. Gangopadhyay,et al.  Understanding frameworks by exploration of exemplars , 1995, Proceedings Seventh International Workshop on Computer-Aided Software Engineering.

[9]  Ralph Johnson,et al.  design patterns elements of reusable object oriented software , 2019 .

[10]  D. L. Parnas,et al.  On the criteria to be used in decomposing systems into modules , 1972, Software Pioneers.

[11]  James O. Coplien,et al.  Pattern languages of program design , 1995 .

[12]  Donald E. Knuth,et al.  Literate Programming , 1984, Comput. J..

[13]  HelmRichard,et al.  Contracts: specifying behavioral compositions in object-oriented systems , 1990 .

[14]  Peter Sommerlad,et al.  Active Guidance of Framework Development , 1995, Softw. Concepts Tools.

[15]  Ralph Johnson.  Documenting frameworks using patterns , 1992, OOPSLA 1992.

[16]  James D. Arthur,et al.  Document quality indicators: A framework for assessing documentation adequacy , 1992, J. Softw. Maintenance Res. Pract..

[17]  Hanspeter Mössenböck,et al.  Scene: using scenario diagrams and active text for illustrating object-oriented programs , 1996, Proceedings of IEEE 18th International Conference on Software Engineering.

[18]  Krzysztof Czarnecki,et al.  ClassExpert: a knowledge-based assistant to support reuse by specialization and modification in Smalltalk , 1996, Proceedings of Fourth IEEE International Conference on Software Reuse.

[19]  Ralph E. Johnson,et al.  Patterns Generate Architectures , 1994, ECOOP.

[20]  Barbara Minto.  The pyramid principle , 1981 .

[21]  Peter Brusilovsky,et al.  Adaptive Hypermedia: An Attempt to Analyze and Generalize , 1996, MHVR.

[22]  B LangeDanny,et al.  Interactive visualization of design patterns can help in framework understanding , 1995 .

[23]  Wolfgang Pree,et al.  Design Patterns for Object-Oriented Software Development , 1994, Proceedings of the (19th) International Conference on Software Engineering.

[24]  G. A. Miller.  THE PSYCHOLOGICAL REVIEW THE MAGICAL NUMBER SEVEN, PLUS OR MINUS TWO: SOME LIMITS ON OUR CAPACITY FOR PROCESSING INFORMATION 1 , 1956 .

[25]  Will Tracz,et al.  DSSA (Domain-Specific Software Architecture): pedagogical example , 1995, SOEN.

[26]  Danny B. Lange,et al.  Interactive visualization of design patterns can help in framework understanding , 1995, OOPSLA.