House of Fusion
Search over 2,500 ColdFusion resources here
  
Home of the ColdFusion Community

Mailing Lists
Home /  Groups /  ColdFusion Talk (CF-Talk)

Creating documentation

  << Previous Post |  RSS |  Sort Oldest First |  Sort Latest First |  Subscribe to this Group Next >> 
Top  |   Reply  |   Original Post  |   RSS Feed  |   Subscribe to this Group
Author:
David Mineer
02/06/2010 06:41 PM

I want to be better about creating documentation for the coldfusion apps that I write.  I wonder what you all are using? Today I have been searching for options.  Two options that I have looked at are google sites and trac. I have been using svn for years for source code control through csvdude and it comes with trac.  We also have google sites, which I like, but it is so basic and difficult to use. Trac isn't bad, but.... I would just like to hear what everyone uses to create documentation. Thanks, -- David Mineer Jr --------------------- The critical ingredient is getting off your butt and doing something. It's as simple as that. A lot of people have ideas, but there are few who decide to do something about them now. Not tomorrow. Not next week. But today. The true entrepreneur is a doer.

Top  |   Parent  |   Reply  |   Original Post  |   RSS Feed  |   Subscribe to this Group
Author:
Mike Chabot
02/06/2010 07:38 PM

It sounds like you are considering documentation targeted at other programmers on the project team. Is this correct? Identifying the target audience helps determine the programs to use. -Mike Chabot ----- Excess quoted text cut - see Original Post for more -----

Top  |   Parent  |   Reply  |   Original Post  |   RSS Feed  |   Subscribe to this Group
Author:
David Mineer
02/07/2010 08:55 AM

Yes, your right.  Although I am the only one on the team.   I constantly find myself having to "study up" on a portion of code I wrote years, or actually even just months ago, because I can't remember what the heck I was thinking.  I also find that creating documentation forces me to think through stuff a little better. Also, if something were to happen to me, I would like a resource that my business could turn to that would help keep tings going. But, this is mainly for internal purposes.  I guess I should also consider documentation for users, but right now I am more interested in documentation for my own reference. ----- Excess quoted text cut - see Original Post for more -----

Top  |   Parent  |   Reply  |   Original Post  |   RSS Feed  |   Subscribe to this Group
Author:
Gerald Guido
02/06/2010 11:01 PM

I am a big fan of tiddlywiki. It is a single page JS app that you can distribute with your source code that basically runs as a desktop app. Very slick. http://www.tiddlywiki.com/ HTH G! ----- Excess quoted text cut - see Original Post for more -----


<< Previous Thread Today's Threads Next Thread >>

Search cf-talk

March 20, 2010

<<   <   Today   >   >>
Su Mo Tu We Th Fr Sa
   1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31