The Artima Developer Community
Sponsored Link

Agile Buzz Forum
SmalltalkDoc Use Cases - Creating Overview Documentation

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 - Creating Overview Documentation Posted: Apr 1, 2006 10:36 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 - Creating Overview Documentation
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: 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.

Read: SmalltalkDoc Use Cases - Creating Overview Documentation

Topic: Speaking in Toronto Previous Topic   Next Topic Topic: Product Planning and Delivery

Sponsored Links



Google
  Web Artima.com   

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