Hi. I have to write a technical document of my project and I would like to have some information on what I should put in it.
Any help will be appreciated.
I know how to write a user guide but a technical guide I'm at a lost.
Thanks for your help.
03-05-2002, 12:20 PM
If possible, data flow and work flow diagrams are some of the
most useful technical documents you can include. Even database
layout diagrams are very useful, something along the lines of a
simple entity-relationship diagram.
Thank you Thinker.
Anything else??? It's my first tech. guide so I'm a little short on idea.
I know I will have to do some sort of diagram of the browsing sequence of the program, but after that I don't have many idea.
But now I have a start!!! :cool:
03-05-2002, 02:59 PM
Draw a spider type diagram of the way your functions and subs call each other. This always generate nice looking pages for my documentations... heh.
Also - include some info on why you're doing particular functions if they have a special and slightly obscure purpose.
Thanks for the suggestion.
Any software recommanded to use to do it??
03-06-2002, 08:30 AM
We use SmartDraw (http://www.hallogram.com/smartdraw/?source=goto) to make flowcharts and such. Standard Edition is around 70 USD$ I think.