Page 39 : 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
A broader perspective on the use of an elucidator
Here we will list a number of potential areas which we expect can be supported by the elucidator.
Most documents that need to address program units or program details will be able to benefit from the ideas of elucidative programming
Documents with 'an elucidative potential':
Diaries and logs
Written code reviews and code walk throughs
Program tutorials
Design documents
Maintenance documentation