The Artima Developer Community
Sponsored Link

Agile Buzz Forum
SmalltalkDoc Use Cases - Using Subsystems

0 replies on 1 page.

Welcome Guest
  Sign In

Go back to the topic listing  Back to Topic List Click to reply to this topic  Reply to this Topic Click to search messages in this forum  Search Forum Click for a threaded view of the topic  Threaded View   
Previous Topic   Next Topic
Flat View: This topic has 0 replies on 1 page
James Robertson

Posts: 29924
Nickname: jarober61
Registered: Jun, 2003

David Buck, Smalltalker at large
SmalltalkDoc Use Cases - Using Subsystems Posted: Apr 1, 2006 4:37 AM
Reply to this message Reply

This post originated from an RSS feed registered with Agile Buzz by James Robertson.
Original Post: SmalltalkDoc Use Cases - Using Subsystems
Feed Title: Richard Demers Blog
Feed URL: http://www.cincomsmalltalk.com/rssBlog/rademers-rss.xml
Feed Description: Richard Demers on Smalltalk
Latest Agile Buzz Posts
Latest Agile Buzz Posts by James Robertson
Latest Posts From Richard Demers Blog

Advertisement

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.

Read: SmalltalkDoc Use Cases - Using Subsystems

Topic: A Retrospective on Retrospectives Previous Topic   Next Topic Topic: Repeating History

Sponsored Links



Google
  Web Artima.com   

Copyright © 1996-2019 Artima, Inc. All Rights Reserved. - Privacy Policy - Terms of Use