Pedagogical framework documentation: how to document object-oriented frameworks. an empirical study
- Author:
- Ian Chai,
- Adviser:
- Ralph Johnson
Abstract
No abstract available.
Cited By
Dagenais B and Robillard M Creating and evolving developer documentation Proceedings of the eighteenth ACM SIGSOFT international symposium on Foundations of software engineering, (127-136)- Aguiar A A minimalist approach to framework documentation Addendum to the 2000 proceedings of the conference on Object-oriented programming, systems, languages, and applications (Addendum), (143-144)
Recommendations
Documentation threads - presentation of fragmented documentation
In this paper, we introduce a means for presenting fragmented documentation through a concept called documentation threads. A documentation thread presents a number of documentation fragments specified by the programmer and can guide a documentation ...
A minimalist approach to framework documentation
OOPSLA '00: Addendum to the 2000 proceedings of the conference on Object-oriented programming, systems, languages, and applications (Addendum)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 ...