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.
> Geoff, I do this (using code comments for documentation) and it works
> great. I add an introduction, information about the purpose of the
> different modules, why you should use them, how they can be used to
> produce x and y and then just provide the API descriptions extracted
> from the code.
>
> I'm lucky I guess, because playing in the code is not really an issue in
> my company, so I can really comment each class, method, parameter... As
> I would if I was doing it from scratch.
Same here, and yes, it works quite well.
I completely disagree with the statement "There's no reason you
couldn't embed this documentation in the code, other than code bloat
and the fact that it's
a hideously inefficient way to create docs." and feel Geoff's advice
is sorely misguided.
Wrapping in documentation at the source code level requires a slightly
different practice, but the fundamentals are all the same. This
practice is no more hideously inefficient than any other practice,
it's just different. And, as with any practice, how it comes out is
directly proportional to the thought and effort that went into
creating it.
I also have issues with the blanket assumption that developers hate to
document/comment their code. I've met some that dislike to do it, and
I've met others that deem it a critical aspect of their profession.
Honestly, I was left deeply disappointed with Geoff's reply, as
usually his advice is quite sound and on the level. Bad day, Geoff?
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.
