Users: Technical writers with Smalltalk experience.
Problem: Smalltalk IDEs provide ways to attach comments to some
objects but not all. Comments are simply plain text strings and they cannot be
cross-linked as hypertext. No guidelines are provided to make these comments
truely useful to different audiences.
Solution: SmalltalkDoc provides for more comprehensive and integrated
documentation. Comments are XML, which may contain formatting, cross-links, and
the possibility of code expressions. SmalltalkDoc reifies documentation in a way
that helps developers write useful documentation with less effort. Automated
code checks can catch common problems, such as class comments becoming outdated
when instance variables are added or removed.