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:Seth Johnson <seth -dot- johnson -at- RealMeasures -dot- dyndns -dot- org> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 29 Sep 2004 16:01:51 -0400
(At the risk of being irritating, I will comment again on Leo
here: You can independently use Leo this way, and it lets you
really mess with the code. You can save the code without the
comments, too. Plus, you'll probably end up showing the coders
what you're doing, and they'll say Omigosh! -- Seth)
dmbrown -at- brown-inc -dot- com wrote:
>
> 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.
>
> If it's all good, show the developers the diff output, and tell them the
> code compiled.
>
> After a few cycles like this, they'll probably come to trust you. It's a
> great feeling.
>
> Be prepared for one of your edits breaking something somewhere eventually,
> though--it's probably inevitable.
>
> The longer you can forestall that event, the more forgiving they'll be when
> it happens. (They break stuff, too.)
I reserve no rights restricting copying, modification or
distribution of this incidentally recorded communication.
Original authorship should be attributed reasonably, but only so
far as such an expectation might hold for usual practice in
ordinary social discourse to which one holds no claim of
exclusive rights.
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.
