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.
> 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.
What a pathetic viewpoint.
If you follow the standard practices that each and every developer
follows, do a local build before checking in your changes, run what
unit tests are necessary to check the integrity of the code, and then
check it back in.
Honestly, code comment edits are the absolute simplest tweaks to make
to source code, as they are *comments*, not code.
Of course, you'll want to know what to do before you up and do it. So
talk to your dev team, explain the benefits and desire, and how it
will make THEIR jobs easier (if that's a concern), and approach it as
a team.
Working in a vacuum or a silo just doesn't work. Collaboration works.
> Personally, I'd let sleeping dogs lie. Here, those
> kind of comments are not meant for public consumption.
> I would consider myself a "view only" user of those
> comments.
Sleeping dogs never get anywhere... they just lay around, drooling on
the carpet. Wake 'em up and take them someplace nice.
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.
