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.
I'm new to the tech writing world, and have just been assigned the task of
documenting the code/comments of our latest software version. Trouble is,
I've never documented developers' code.
After searching the Techwr-l database for clues, I couldn't find anything
that really touched deeply on the issue.
Here's a call for help - can anyone out there provide some suggestions,
point me in the right direction, or offer some sites I could look at for
examples? I'm told the documentation doesn't have to be perfected, exacting
every detail of the code, but rather touching the surface - 'The code says
this, and this is what it means.'
Any help would be greatly appreciated.
Thanks.
Ken Wasden
Information Technology - Technical Writer
www.WebFamilies.com
