Writing documentation for developers

Subject: Writing documentation for developers
From: "Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 10 Nov 2006 09:11:34 -0600

What a subject for Friday, but here goes:

Apart from writing all the help documentation for our new proprietary
software, I have to go back and look at the procedures we're importing
from the old system to the new one. That involves deciphering
PowerScript and SQL code-generally the stored SQL procedures. What we
want is a document we can hand to our contract developers so they can
see how the old code worked and write the new code in a .NET
environment. (I'm not sure what language we're using in .NET yet-it's
not that important to me.) What I have so far is a short document with
the following four headings:

Overview-what the program does.
Data Selection-how the stored data is selected.
Data Exclusion-exceptions to selection requirement.
Processing-what we do with the data (create batch files, reports, etc.)

I know enough about SQL to know what the code is doing, but that's my
current limit. For those of you out there who have worked with
developers during a transition like mine, I'd like to know if what I've
described is sufficient for a new developer who's not familiar with the
old system.



WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: Re: Writing Help about Help
Next by Author: Re: WTH is Going On? WAS: TechCommPros mailing list
Previous by Thread: Re: VHS to DVD?
Next by Thread: Re: Writing documentation for developers

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

Sponsored Ads