Code documentation requirements?

Subject: Code documentation requirements?
From: Lani Hardage <lhardage -at- RMTECH -dot- COM>
Date: Wed, 21 Jan 1998 13:37:52 -0800

I am the only techwriter doing end-user docs, and the company wants
someone to document code. I'm supposed to interview the applicants, but
they've asked me whether I'd consider doing it.

What would you look for, since our company has a product written in C,
some new code in C++ (with some APIs in the pipeline), and Visual Basic?

I'm learning VB and have coded a little (Basic and Fortran) myself but
never documented code. Would it be better for me to learn on the job,
since most of our applicants want to do end-user documentation, or is it
too hard to learn on the job? What questions do I need to ask of
management?

Sorry to ask several far-ranging questions, but that's what's going on!

TIA,

Lani Hardage
Technical Writer
Risk Management Technologies
lhardage -at- rmtech -dot- com




Previous by Author: Fonts
Next by Author: SUMMARY: Code documentation requirements
Previous by Thread: Summary: HTML index (part 3 of 3)
Next by Thread: Re: Code documentation requirements?


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


Sponsored Ads