Re: Code comments as Documentation
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.)
<:)
--David
=========================================================================
A V A I L A B L E N O W ! http://www.html-indexer.com
HTML Indexer is still the easiest way to create and maintain real indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
Follow-Ups:
- Re: Code comments as Documentation, Seth Johnson
Previous by Author:
Re: Knowledge Base Design
Next by Author:
Re: Code comments as Documentation
Previous by Thread:
Re: Code comments as Documentation
Next by Thread:
Re: Code comments as Documentation
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads