Re: OT: Website Documentation?
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... h... -nathan strutz http://www.dopefly.com/ Mike Kear wrote: 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 wrote it thought the comments would bloat the code. HAH! Documentation! Whatever will they think of next. Cheers Mike Kear Windsor, NSW, Australia AFP Webworks http://afpwebworks.com .com,.net,.org domains from AUD$20/Year On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: 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 the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - New Atlanta http://www.newatlanta.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185946 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
OT: Website Documentation?
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 the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - RUWebby http://www.ruwebby.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185814 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: OT: Website Documentation?
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 I put for Chapter 1 it forces you to be consistant with your documentation. After you make the docbook xml, you can make the xml file into RTF, PDF, HTML, man pages, and a bunch of other formats. On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: 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 the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Gold Sponsor - CFHosting.net http://www.cfhosting.net Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185826 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: OT: Website Documentation?
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 wrote it thought the comments would bloat the code. HAH! Documentation! Whatever will they think of next. Cheers Mike Kear Windsor, NSW, Australia AFP Webworks http://afpwebworks.com .com,.net,.org domains from AUD$20/Year On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: 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 the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - CFDynamics http://www.cfdynamics.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185889 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
