Pedagogical Framework Documentation: How to Document Object -Oriented Frameworks. An Empirical Study
type: CreativeWork
description: Frameworks are a key to reuse in the Object-Oriented programming world, but they are hard to learn and document. Different people have proposed different ways to document frameworks, but it is unclear which ones actually are better, so we did an empirical study to see which documentation philosophy is best for documentation for new users of a framework. We found that different documentation styles are better for different situations, depending on what your goals are, and discovered guidelines that can help someone who is trying to document a framework.
abstract: Frameworks are a key to reuse in the Object-Oriented programming world, but they are hard to learn and document. Different people have proposed different ways to document frameworks, but it is unclear which ones actually are better, so we did an empirical study to see which documentation philosophy is best for documentation for new users of a framework. We found that different documentation styles are better for different situations, depending on what your goals are, and discovered guidelines that can help someone who is trying to document a framework.
author: Chai, Ian
language: eng
keywords: Computer Science
date published: 2015-09-25T20:21:16Z
date modified: 2026-07-22T22:26:17Z
provider: University of Illinois - Urbana-Champaign
publisher: Networked Digital Library of Theses and Dissertations
type: WebPage
source organization: University of Illinois at Urbana-Champaign

PropertyValue
property ID: Handle
value: http://hdl.handle.net/2142/81977