Re: OT: Website Documentation?

2004-12-02 Thread Nathan Strutz
LOL Mike, I had some of that zillion-line no-comment code when I started my current job, but worse yet is when there's a zillion comments, but they're only for commenting out code. Also, my boss and a co-worker had the idea that stripping out comments would reduce our bandwidth... yeah... hmmm

Re: OT: Website Documentation?

2004-12-01 Thread Mike Kear
WOW! Documentation! I've never worked on anyone else's code that had much in the way of comments, let alone documentation. I've recently been working on a template that had more than 8500 lines!!! with a gazillion loops and nested CFIFs, and not a single comment anywhere. I guess the guy who

Re: OT: Website Documentation?

2004-12-01 Thread Rob
I like to use Docbook - it gives tags specific to technical documenation. Its somewhat of a standard for open source projects. You can google for DocBook to get a feel for what its about. The editor I like to use is XXE http://www.xmlmind.com/xmleditor/. While it wont help you with, like, what do

OT: Website Documentation?

2004-12-01 Thread Claremont, Timothy
Does anyone on the list have any pointers or website URLS that dictate some "best practices" when it comes to CF based web site documentation? It guess I am looking for advice on how to create an "owners manual" for the website that will allow another webmaster to step in and take over if and when