Documentation

Hi there. I am a junior software engineer and I am working on a project in Visual Basic. I have to writ e a documentation about the program, but I really do not know how. Have never done it before. It may sound stupid but I really would like some help..Thanks in advance..

I just would like to know how the structure of the document must be...

Who is the documentation for ?
The end user or other developers?

Hi there Peet, thanks for answering.
It is for other developers. it is an excisting program with a big code in visual basic in combination with word. but ther is any documentation about it. And I have to write the documentation and rewrite the code. You can mail me directly to my email if you [email protected]....

This should be in u'r documentation

General purpose of the app

General structure of the app

Listing of what comp. is needed for the app to run

Listing of the classes, and modules in the app with generel expl. of what their purpose is.

Listing of props, methodes, events, subs and functions, and offcourse their purpose.

........

Ok thank you very very much. I now have something to go on. Thanks again...

God I hate the documentation part of developing.... how about you ? :)

Well this is my first time...most of the time I just have to write a code and check if the program is running ok. So that is why I almost got a nervous breakdown with this documentation part. But ok, with whta you told me I think I can get along...Do you program in visual basic a lot? THis is my first project in vb.

yes I do some programming in VB, and I like it alot :)

what tool are u going to use for your documnetation?

I use the RoboHelp , Its great.

Robohelp? that is new for me..:)
I am not familiar with the vb developing environment...I did the vb course but since then did work with it. So it is all new to me...

I know javadoc is used for documenting Java code so I just searched for javadoc AND "Visual Basic" on google there might be something useful here

http://www.google.co.uk/search?as_q=...arch=&safe=off

I tried to download this one but had problems...

http://www.programmersheaven.com/zone1/cat596/16930.htm

Ok thanks very much..I did chechk it out and indeed there are some useful things I can "use"...

Can you let me know if you find anything that's any good?

Thanks

Sure...!!!!:)

Documentation is time costly, but when someone other than you looks at your code, it is the only thing standing between them and insanity. :D