One consideration is that the author needs expertises in code sharing. Most
engr organization use tools like ClearCase, CVS, etc to manage their code.
This requires the following knowledge:
* How to check out, check in code modules.
* How to "tag" modules with specific release information.
* How to merge changes when someone else has modified the same file that you
have.
Here's an example of how I add comments to code:
1. I write reference documentation about configuration parameters.
2. Not all params are documented (some are internal-use only).
3. But un-documented params appear in the installed configuration files.
4. I add comments to the config files to define the un-doc'd params.
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.
