TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Code comments as Documentation From:jsokohl -at- mac -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 29 Sep 2004 13:27:48 -0600
> jsokohl -at- mac -dot- com wrote:
> > Trust issues, I'm sure.
>
> Get a copy of the code, make the changes, do a diff, check your work, and
> compile the code.
Minor point, but our code's not compiled, it's interpreted (JavaScript &
XML & JSP). Too, a build to test this stuff requires other folks to stand
up the database...not a trivial thing and not a one--person event.
Ironically, because it's interpreted code (SQL/PL, too), ya'd think they'd
trust me even more. Despite 14 years in this biz, despite JS & HTML
knowledge & abilities, I'm "just a formatter to make things look pretty"
it seems.
> The longer you can forestall that event, the more forgiving they'll be when
> it happens. (They break stuff, too.)
Perhaps, but they're _deVELopers_ and I'm not. I'm in a classic, archaic
programmers-as-priest circle of the Inferno.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.