Sweet! That's exactly what my presentation was going to be about at the
conference.
The goal from my perspective is not only to have better documented, well
written code. But applications that you can write absurdly quick
because of how well it's spec'd.
Alan, you're arriving in Virginia a couple days early, aren't you? Come
over to my office and I'll go into detail about this process i've been
using, it's really slick.
Steve
"McCollough, Alan" wrote:
>
> I've (in vain) tried understanding UML, and have looked at the fUseML
> project, and do believe that's where the answer lies.
>
> "Documentation" is a comprehensive subject, far more involved than a few
> comment tags in a template. If I could understand the Unified Modeling
> Language, if there was a 5-page "crash course" on it, I'd jump to use it.
>
> I'd like to have a programming methodology that integrates the entire
> development process, and leaves me with comprehensive docs, from the "idea"
> stage right down to the final product. I'm sure all of you would like to see
> something similar.
>
> SoOo, what ever became of the request for a Visio UML reader-generator
> thing?
>
> Alan McCollough
> Web Programmer
> Allaire Certified ColdFusion Developer
> Alaska Native Medical Center
>
> > -----Original Message-----
> > From: Steve Nelson [SMTP:[EMAIL PROTECTED]]
> > Sent: Wednesday, August 23, 2000 10:14 AM
> > To: [EMAIL PROTECTED]
> > Subject: Re: Documentation System for Cold Fusion
> >
> > I think Fusedoc is perfect for the fuse level, but I think we could add
> > to it and create similar docs fuseactions and circuit applications.
> >
> > I think fuseactions and circuit applications are slightly different from
> > fuses... because they are more geared towards a "specification" (i.e.
> > what do I want this to do) whereas a fuse is more geared towards a
> > "design" (i.e. how will I build what it is that I want to do) Saying
> > that, I think fuseaction and circuit application docs might be less
> > emphasizing on attributes and more emphasizing on explanations, that way
> > you only have to manage documentation on attributes in one place.
> >
> > thoughts?
> >
> > Steve
> >
> > Hal Helms wrote:
> > >
> > > FWIW, it would be really good if we could agree on a standard for
> > > documentation that would allow various engines to operate on the docs. I
> > > proposed Fusedoc for this reason and I've been happy with it, but if we
> > want
> > > to make changes, I would encourage to go this route rather than have
> > another
> > > standard. Just my 2 cents.
> > >
> > > -----Original Message-----
> > > From: John Quarto-vonTivadar [mailto:[EMAIL PROTECTED]]
> > > Sent: Wednesday, August 23, 2000 7:50 AM
> > > To: [EMAIL PROTECTED]
> > > Subject: Re: Documentation System for Cold Fusion
> > >
> > > Hi Paul,
> > >
> > > Please don't take the silence for dis-interest! :)
> > >
> > > a) it is August and so people are on vacation
> > > b) it took a moment to figure out exactly what you've been trying to do
> > >
> > > in fact I did download your cfdoc and had some fun playing with it. In
> > fact
> > > it immediately gave me the impetus to work on my other oft-neglectred
> > > project, which automatically *write* fusebox style code, and which is
> > > compliant with Hal's Fusedox documentation notation. So today I'll be
> > > spending more time in integrating the various ideas and hope to have
> > > something ready by the conference (will you be there?).
> > >
> > > the only modifications to your code that I've done is to clean up the
> > series
> > > of <cfif><cfelseif></cfif> into a <cfswitch> and also to add iconic
> > display
> > > of the directory information. I've also sorted the output so that it is
> > > case-insensitive (i know that drives the UNIX people crazy but I've just
> > > gotten too used to the idea of case-insensitive alphabetical sorting!)
> > >
> > > > Due to the lack of interest in my last posting, I am re-posting (sort
> > of)
> > > a
> > > > mail to get some feedback.
> > > >
> > > > I have created a documentation system called cfdoc. I know there are
> > > > others, but they all seem a little complex for me, and not so
> > > transferrable
> > > > and useful in other circumstances. It took me about an hour to create
> > it,
> > > > and it now has a web page where you can download the browser that I
> > made,
> > > > and there is also a syntax reference. It is similar to Plain Old
> > > > Documentation (as in Perldoc) because it is similar in style, simple,
> > and
> > > > straightforward to use.
> > > >
> > >
> > >
> > --------------------------------------------------------------------------
> > --
> > > --
> > > To Unsubscribe visit
> > > http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox
> > or
> > > send a message to [EMAIL PROTECTED] with 'unsubscribe'
> > in
> > > the body.
> > >
> > >
> > --------------------------------------------------------------------------
> > ----
> > > To Unsubscribe visit
> > http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox or
> > send a message to [EMAIL PROTECTED] with 'unsubscribe' in
> > the body.
> > --------------------------------------------------------------------------
> > ----
> > To Unsubscribe visit
> > http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox or
> > send a message to [EMAIL PROTECTED] with 'unsubscribe' in
> > the body.
> ------------------------------------------------------------------------------
> To Unsubscribe visit
>http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox or send a
>message to [EMAIL PROTECTED] with 'unsubscribe' in the body.
------------------------------------------------------------------------------
To Unsubscribe visit
http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox or send a
message to [EMAIL PROTECTED] with 'unsubscribe' in the body.
