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.
Quoting France Baril <France -dot- Baril -at- ixiasoft -dot- com>:
> 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.
The usefulness of code comments as documentation depends largely on how they are
written. I've worked at places where the comments were useless for
documentation. At others (typically, open source companies, or companies where
lead developers have been active in open source), the comments are detailed
enough that they amount to a tutorial. The practice is only as good - or as bad
- as the comments themselves.
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.
