Page 25 : 47
Elucidative Programming
* Introduction
Introduction
Kinds of understanding
Plan of the IWPC talk
Plan of the COT talk
Plan of the SIGDOC talk
* Overall Observations
Which kind of documentation
Views on documentation
Integrated program documentation
* Literate Programming
Literate Programming and the WEB System
An example of a literate program
Internal structure of a literate program (1)
Internal structure of a literate program (2)
The WEB tools for literate programming
Problems with WEB-like literate programming
* Elucidative Programming
The meaning of the word
Elucidative Programming
Requirements
An example of an elucidative program
An example of an elucidative program
Examples of elucidative programs
The elucidative programming model
The source format of the documentation - Scheme
The source format of the documentation - Java
Tool Overview
The elucidator tool
The editor tool
The browser tool
Tool Integration
Tool philosophy
The Scheme Elucidator
The Java Elucidator
The Design of the Java Elucidator
Minor features
NWPER'2000 Questions
A broader perspective on the use of an elucidator
* Experience
Educational experience
Industrial experience
Industrial quotes
* Status and Conclusions
Status and Conclusions
* Further Information
Web resources about EP
The elucidative programming model
This page describes a number of important concepts behind the elucidative programming model.
Entities
Named abstractions
on the program side
Sections
and
subsections
on the documentation side
A
naming scheme
that allows us to address the program entities from the documentation
Relations
A
doc-prog
relation which connects explanations with program entities.
A
prog-prog
relation which connects applied and defined name occurrences
A
doc-doc
relation which connects explanations across the hierarchical documentation structure
Source markers
Represent positions in a program which we want to address in the explanations
Documentation bundle
An aggregation of programs, documentation texts, and additional properties (e.g., processing options)