Justin W. Reagor on 1 May 2007 12:51:14 -0000


[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]

Re: [PhillyOnRails] Documentation for your Rails (and otherwise) apps

  • From: "Justin W. Reagor" <justinwr@gmail.com>
  • To: Philly on Rails <talk@phillyonrails.org>
  • Subject: Re: [PhillyOnRails] Documentation for your Rails (and otherwise) apps
  • Date: Tue, 1 May 2007 08:51:02 -0400
  • Dkim-signature: a=rsa-sha1; c=relaxed/relaxed; d=gmail.com; s=beta; h=domainkey-signature:received:received:mime-version:in-reply-to:references:content-type:message-id:content-transfer-encoding:from:subject:date:to:x-mailer; b=TdEYIcm1Sz0TYIqu6wx2L2nPbOiA8vWjjdk5GNBKz2CBIfgAV41PcSB+8i10SpVH42P32O21I847uBpq/8cnobC9yMYmHf9WwUfl1Ce6r9LLLm11q3BxTMLiZx5gD7UXY967r6R2zOpPDGayGCsbVfjuNjjffGE9p/Dm/Xt6Ark=
  • List-archive: <http://lists.phillyonrails.org/pipermail/talk>
  • Reply-to: talk@phillyonrails.org
  • Sender: talk-bounces@phillyonrails.org

Mike,

I'm not sure if anyone has mentioned this to you already, but Railroad (http://railroad.rubyforge.org/) is a great lil tool that will draw DOT diagrams of model relationships and actions! We are going to start using this at work to support other project documentation.

:: Justin W. Reagor
:: justinwr@gmail.com



On Apr 30, 2007, at 10:23 PM, Pat Nakajima wrote:

Check the agile development plugin list. I believe there are a couple plugins that will draw up model relationships etc. I've always found good old rdoc to work perfectly well.

via BlackBerry

-----Original Message-----
From: "mike nicholaides" <mike.nicholaides@gmail.com>
Date: Mon, 30 Apr 2007 21:49:14
To:talk@phillyonrails.org
Subject: [PhillyOnRails] Documentation for your Rails (and otherwise) apps


Hey folks,

We at the Growth Cycle are looking to improve the way we do
documentation for our Rails apps.  Right now our documentation is
sparse.  Fortunately, Rails is rather readable and our tests serve as
documentation.  As our applications grow in size and complexity,
however, we want to communicate more effectively, especially between
the development and management layers.

Any tips from those more experienced with documentation?
Any tools you find especially useful for communicating business logic?
We use DOT right now for making flowcharts, but are thinking about
switching to some mind mapping tool.

Thanks,
Mike
_______________________________________________
To unsubscribe or change your settings, visit:
http://lists.phillyonrails.org/mailman/listinfo/talk
_______________________________________________
To unsubscribe or change your settings, visit:
http://lists.phillyonrails.org/mailman/listinfo/talk

_______________________________________________ To unsubscribe or change your settings, visit: http://lists.phillyonrails.org/mailman/listinfo/talk