Re: ADMIN: Code Comments as Documentation

Subject: Re: ADMIN: Code Comments as Documentation
From: jsokohl -at- mac -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 30 Sep 2004 11:05:26 -0600


???????????/
I musta missed something, but the latest thread certainly seems on topic
AFA technical writing is concerned. Who performs code documentation, who
edits it, what audience it's written for, what's done with code doc--is it
extracted to provide API documentation or design documentation, or is it
just for developers? As a tech writer coordinating a software design
description (SDD), this is a critical topic.
Maybe there were off-topic posts I missed...
joe

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

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.



Previous by Author: Re: Code comments as Documentation
Next by Author: Re: OT: Office Chairs (Balance Ball Chair)
Previous by Thread: ADMIN: Code Comments as Documentation
Next by Thread: Re: ADMIN: Code Comments as Documentation


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


Sponsored Ads