Re: Code comments as Documentation

Subject: Re: Code comments as Documentation
From: Leigh Price <price_leigh -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 30 Sep 2004 09:17:14 -0700 (PDT)



--- TechComm Dood <techcommdood -at- gmail -dot- com> wrote:

> What a pathetic viewpoint.

<sarcasm>Oh well, I guess I'm just a pathetic
technical writer who would rather focus on creating
documentation for end-users than cleaning up code
comments that are not written for public
consumption.</sarcasm>

Many PPs indicate that their department uses code
comments as the basis for doc. That's different.

> Working in a vacuum or a silo just doesn't work.
> Collaboration works.

My position is not anti-collaboration. I personally
can understand a developer who does not non-developers
accessing the code. Granted, I work for a small
company. Our process may have to change as the company
grows. For the time being, I do not need access to the
code to collaborate with developers, or to feel like I
have gained their respect. I TALK to them.

> Sleeping dogs never get anywhere... they just lay
> around, drooling on
> the carpet. Wake 'em up and take them someplace
> nice.

Sticks and stones, dood.

Leigh

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

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.



References:
Re: Code comments as Documentation: From: TechComm Dood

Previous by Author: Re: Code comments as Documentation
Next by Author: Double Posts?
Previous by Thread: Re: Code comments as Documentation
Next by Thread: Re: Re: Code comments as Documentation


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


Sponsored Ads