Re: Re: Code comments as Documentation

[Susan W. Gallagher <sgallagher5 -at- cox -dot- net>]

I edit code all the time and have full check in/out privs in
CVS. If something breaks, it's my name on the check-in
comment... But it hasn't happened yet and I'm really not
expecting it to. If you're charged with documenting code,
it helps if you have access to it and tools to do it with.
<g>

The code itself may belong to the devs; the documentation of
it, however, belongs to me.

-Sue Gallagher

> 
> From: Leigh Price <price_leigh -at- yahoo -dot- com>
> 
> Personally, I would not want to edit the code,
> directly or indirectly. Even though I consider myself
> capable of applying such edits without mucking things
> up, I think that territory belongs to developers. I'm
> sure
> there are special characters that could wreak havoc on
> the code, even if those characters were commented out.
> Plus, if something went wrong, the lowly doc person
> would be the most likely scapegoat. I know that if I
> asked for that kind of access here, we'd be laughed
> at.
>  



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.