Slightly OT - VB programming logic in Functional Specification

Slightly OT - VB programming logic in Functional Specification

Post by Little Pus » Wed, 16 Feb 2005 00:07:08



Hello,

I think this is slightly off topic. Feel free to point me in the direction
of a different newsgroup.
However I have written several systems for a company using VB6.
To cut a long story short I have been asked to amend the functional
specifications as we have to include a section called
Programming Logic, whereby I have to describe the code.
I'm not too sure of the best way to approach this and would like some
outside advice.
Would I copy and paste the relevant code into the document
How would you do it?

Thanks,
Regards,

Jayne
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Mike Willi » Wed, 16 Feb 2005 02:51:09


That's probably so that they will understand the code as well as you do,
which will enable them to get rid of your services when they feel the need
to do so. Have they offered you any more money for this?

Mike

 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Michael B. » Wed, 16 Feb 2005 05:26:48

On Mon, 14 Feb 2005 15:07:08 +0000, Little *** Cat


<snipped/>


I wouldn't fob this kind of work off on people in this newsgroup, I
would begin by adding comments within the source code - that's the
only thing guaranteed to stay up to date anyway. As you write the
comments try to understand the intent of the original code. Abstract
it higher and higher with summarizing comments. Eventually, you should
end up with something that describes the programming logic. However,
this may not answer the question of "why" the code was written, what
problem it solves.
_______________________
Michael B. Johnson
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by neilaness » Wed, 16 Feb 2005 05:35:35


Little *** Cat,
MEOWWWWWWW;-)))))))))
Minimally I would create a catalogue of all modules, classes and forms
describing their main roles. Also a catalogue of all functions and
procedures with inputs/outputs/affects (calling dependencies etc)...In
the past I have also provided UML object diagrams and other nifty
documents.

Program begins in sub Main. An instance of UniversalGuardDog is
created to Instantiate the Universe and protect it from evil
hackers.....UniversalGuardDog builds WorldOne which is left to spin off
into oblivion until the AllHellIsBreakingLoose Event is raised by the
WorldOne class. UniversalGuardDog intercepts the AllHellIsBreakingLoose
event and Instantiates an Instance of the EverybodyCoolOut class
passing it a pointer to the WorldOne object. The EverybodyCoolOut
object instance sprays Water and Beer on everything going nuts on the
World1 object and everybody Cools Out. World1 Raises the AllIsCool
Event and UniversalGuardDog goes to sleep......Until AllHellBreaks
loose again ...repeat until Drunk as Hell or WorldOne explodes
whichever happens first!
Neila
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by marks54200 » Wed, 16 Feb 2005 05:56:45


forms
etc)...In
off
AllHellIsBreakingLoose




I would provide a flowchart of the programs logic. It sounds like they
want enough documentation so that someone else can change the program
if you get run over by a beer truck.

Add procedure names to the flowchart as required.
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Little Pus » Wed, 16 Feb 2005 06:22:00


:-)
Oh yes, I wouldn't be doing it otherwise...

Jayne
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Little Pus » Wed, 16 Feb 2005 06:31:38


Thanks,
I will check the source code comments and see if its up to date,
I always put a comment section above each function, sub to describe what it
does.
I know if using Visual C++ there is a code documenter which you can get
which creates a kind of organised structure for documenting but I've never
come across one for VB6 before...

Jayne
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Little Pus » Wed, 16 Feb 2005 06:32:21


Thankyou for that!

Jayne
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Little Pus » Wed, 16 Feb 2005 06:33:34


Yeah, thanks, that has given me some ideas.
Thankyou for all of your help everyone!

Jayne
 
 
 

Slightly OT - VB programming logic in Functional Specification

Post by Michael B. » Thu, 17 Feb 2005 00:53:33

On Tue, 15 Feb 2005 09:36:06 -0500, "Graham" < XXXX@XXXXX.COM >



For an alternative that uses comments extracted from VB6 code, see
www.mztools.com and review its XML documentation.
_______________________
Michael B. Johnson