RE: Writing documentation for developers

Subject: RE: Writing documentation for developers
From: "Hickling, Lisa (TOR)" <lhickling -at- Express-Scripts -dot- com>
To: "Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 10 Nov 2006 09:30:42 -0600


Are you required to provide info only on data flow? Are the business
components of the system (classes that drive data access) already
documented elsewhere? It'd be hard to say exactly what you'd need
without knowing the scope of your mandate.

Lisa H.

-----Original Message-----
From: Brasel, Russell

... 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. ... 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'd like to know if what I've described is sufficient for a new
developer who's not familiar with the old system.
******* Confidentiality Notice *******
ESI Canada -- Optimizing the value of drug and dental benefits

This email, its electronic document attachments, and the contents of its website linkages may contain confidential health information. This information is intended solely for use by the individual or entity to whom it is addressed. If you have received this information in error, please notify the sender immediately and arrange for the prompt destruction of the material and any accompanying attachments.

******* Avis de confidentialite *******
ESI Canada -- Optimiser la valeur des regimes d'assurance medicaments et dentaires

Ce courriel ainsi que tout document y etant joint de meme que le contenu des liens vers des sites Web peuvent reunir des renseignements confidentiels sur la sante. Cette information s'adresse uniquement a l'usager ou a l'organisation auxquels elle est destinee. Si vous avez recu ce message par erreur, veuillez en aviser l'expediteur immediatement et proceder a la suppression du document et des fichiers joints sans tarder.




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

Previous by Author: RE: Naming NAME fields (was RE: Coordinating Field Defs and Procedura l Info
Next by Author: RE: What are you working on?
Previous by Thread: Re: Writing documentation for developers
Next by Thread: RE: Writing documentation for developers


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


Sponsored Ads