Users: Programmers developing Smalltalk applications.
Problem: The Smalltalk library contains a wide variety of classes of
general use to programmers, each defining a set of generally useful methods.
However, it is difficult for programmers to learn and remember all of them. In
VisualWorks, moreoever, there is no set convention for distinguishing public
from private methods. Programmers usually have to spend time browsing code to
determine which classes and methods are already available and applicable to
their problem. There was formerly an "Object Reference" Guide to the
VisualWorks class library that helped to simplify this task, but this has not
been maintained in over ten years.
Solution: SmalltalkDoc supports documentation for all levels of
Smalltalk components, including individual methods. However, it would probably
not be useful to create SmalltalkDocs for every method of every class, it
would be useful to do so for the generally useful common classes, such as
Strings, Numbers, collections, or, for example, the Pollock objects (Panes,
Agents, etc) that programmers normally work with. More important are the
overview documents for code components that point developers towards the most
important classes and APIs defined within.