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.
Don't know the standard way of doing this, but in a couple of jobs I've
just created a heavily annotated version of the code, heavy on comments
and explanations of what each piece does, ditto the pieces called up at
the beginning (with links to the original code for them).
Of course this has to be modified any time there are code changes, but
that would be the case anyway.
Tracey Moore wrote:
> My company has recently completed a visual basic/java application and we =
> now need to document the code. (All we've done so far is print out the =
> code itself.) Does anyone out there have experience with this?
> How do you document? What should the document look like? Any suggestions =
> on resources for sample documents?
> As you can see, we're babies (uh, make that embryos) at doing this. =
> Thanks in advance for your help.
> From ??? -at- ??? Sun Jan 00 00:00:00 0000==