Users: Programmers developing Smalltalk applications.
Problem: The APIs of Smalltalk subsystems are often not obvious
without considerable study. Developers complain of having to spend hours
reading and studying code before being able to use existing subsystems. The
problem is that the basic components of Smalltalk code (classes, methods,
etc.) do nothing to identify a subsystem's API. Intention revealing names
help, but are not sufficient. Explicit API documentation is needed, including
both text and illustrations, that provides a framework for thinking about a
subsystem and how it is intended to be used.
Solution: SmalltalkDoc supports the documentation of subsystem APIs
through overview documents and through documents associated with bundles and
packages. Figures illustrating the use of a subsystem can be included, along
with explanations.