A model for structuring user documentation of object-oriented frameworks using patterns and hypertext

被引:0
作者
Meusel, M [1 ]
Czarnecki, K [1 ]
Kopf, W [1 ]
机构
[1] Daimler Benz AG, Res & Technol, D-7900 Ulm, Germany
来源
ECOOP'97: OBJECT-ORIENTED PROGRAMMING | 1997年 / 1241卷
关键词
D O I
暂无
中图分类号
TP301 [理论、方法];
学科分类号
081202 ;
摘要
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. This paper presents a model for structuring the documentation of an object-oriented framework. The model integrates existing approaches such as patterns, hypertext, program-understanding tools, and formal approaches into a single structure that is geared towards supporting the three audiences. The model will be illustrated using HotDraw, a Smalltalk framework for drawing editors, as an example. We also give a preliminary evaluation of the model.
引用
收藏
页码:496 / 510
页数:15
相关论文
共 34 条
  • [21] MINTO B, 1991, PYRAMID PRINCIPLE 1
  • [22] MULLER HA, 1996, 18 INT C SOFTW ENG, P2
  • [23] *OBJ TECHN INT INC, 1995, ENVY DEV R3 01 US MA
  • [24] *OBJ TECHN INT INC, ENVY QA
  • [25] PARNAS DL, 1972, COMMUN ACM, V15, P1053, DOI 10.1145/361598.361623
  • [26] *PARPL DIG INC, 1995, VIS COOKB
  • [27] Pree W., 1995, Design Patterns for Object-Oriented Software Development
  • [28] PREE W, 1995, SOFTWARE-CONC TOOL, P136
  • [29] Schmidt D. C., ADAPTIVE COMMUNICATI
  • [30] STEVENS KT, 1988, TR8838 VIRG POL I ST