A minimalist approach to framework documentation

Authors:
Ademar Aguiar
Affiliations:
Faculdade de Engenharia da Universidade do Porto, Rua dos Bragas, 4050-123 Porto, Portugal
Venue:
OOPSLA '00 Addendum to the 2000 proceedings of the conference on Object-oriented programming, systems, languages, and applications (Addendum)
Year:
2000

Citing 5
Cited 0

The Nurnberg funnel: designing minimalist instruction for practical computer skill

The Nurnberg funnel: designing minimalist instruction for practical computer skill
Smalltalk scaffolding: a case study of minimalist instruction

CHI '90 Proceedings of the SIGCHI Conference on Human Factors in Computing Systems
Building application frameworks: object-oriented foundations of framework design

Building application frameworks: object-oriented foundations of framework design
Literate Programming Simplified

IEEE Software
Pedagogical framework documentation: how to document object-oriented frameworks. an empirical study

Pedagogical framework documentation: how to document object-oriented frameworks. an empirical study

Quantified Score

Hi-index	0.00

Visualization

Abstract

Good documentation is crucial for the success of frameworks. In this research, a new documenting approach is proposed combining existing document styles in a kind of “minimalist” framework manual with a special emphasis on framework understandability and usability, rather than on describing framework design. Benefits and drawbacks are evaluated from frameworks of different domains and complexity.