Re: Code Comments, Code Reviews and Tech Writers

Subject: Re: Code Comments, Code Reviews and Tech Writers
From: jsokohl -at- mac -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 6 Oct 2004 13:55:19 -0600

> Check the archives for last week's discussion of "Code comments as
> Documentation".
> Being involved in code reviews is good, but you need to swim further
> upstream and get at least read access to the source control
> system---read-write access is far preferable.=20
Thanks, Janet, for the link & tip. As the author/initiator (instantiator?)
of the thread, I thought I'd report on the decision on how I've been told
to proceed: I'll take the code comments, use them to write software design
description sections (along with the software dev team lead), and there
we'll end--no recursion to the code for cleaner comments so we avoid
stepping on developers' egos (really...I'm not makin' this stuff up!).

So it goes, as the Vonnegut saith.

I'd be interested offline in a copy of your tips as edited....



ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

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!

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 for more resources and info.

Previous by Author: Re: Software Requirements Specification Question
Next by Author: Re: Macromedia renaming RoboDemo
Previous by Thread: Re: Code Comments, Code Reviews and Tech Writers
Next by Thread: Re: Code Comments, Code Reviews and Tech Writers

What this post helpful? Share it with friends and colleagues:

Sponsored Ads