Results 1 to 14 of 14

Thread: Documentation

  1. Jul 18th, 2001, 03:51 AM #1
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7

    Question 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...
    Reply With Quote Reply With Quote
  2. Jul 18th, 2001, 03:55 AM #2
    peet
    peet is offline
    -= B u g S l a y e r =- peet's Avatar
    Join Date
    Aug 2000
    Posts
    9,629
    Who is the documentation for ?
    The end user or other developers?
    -= a peet post =-
    Reply With Quote Reply With Quote
  3. Jul 18th, 2001, 04:00 AM #3
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    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]....
    Reply With Quote Reply With Quote
  4. Jul 18th, 2001, 04:08 AM #4
    peet
    peet is offline
    -= B u g S l a y e r =- peet's Avatar
    Join Date
    Aug 2000
    Posts
    9,629
    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.

    ........
    -= a peet post =-
    Reply With Quote Reply With Quote
  6. Jul 18th, 2001, 04:10 AM #5
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    Ok thank you very very much. I now have something to go on. Thanks again...
    Reply With Quote Reply With Quote
  7. Jul 18th, 2001, 04:12 AM #6
    peet
    peet is offline
    -= B u g S l a y e r =- peet's Avatar
    Join Date
    Aug 2000
    Posts
    9,629
    God I hate the documentation part of developing.... how about you ?
    -= a peet post =-
    Reply With Quote Reply With Quote
  8. Jul 18th, 2001, 04:16 AM #7
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    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.
    Reply With Quote Reply With Quote
  9. Jul 18th, 2001, 04:18 AM #8
    peet
    peet is offline
    -= B u g S l a y e r =- peet's Avatar
    Join Date
    Aug 2000
    Posts
    9,629
    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.
    -= a peet post =-
    Reply With Quote Reply With Quote
  11. Jul 18th, 2001, 04:22 AM #9
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    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...
    Reply With Quote Reply With Quote
  12. Jul 18th, 2001, 04:52 AM #10
    Mark Sreeves
    Mark Sreeves is offline
    Frenzied Member Mark Sreeves's Avatar
    Join Date
    Nov 1999
    Location
    UK
    Posts
    1,845
    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
    Last edited by Mark Sreeves; Jul 18th, 2001 at 05:04 AM.
    Mark
    -------------------
    Reply With Quote Reply With Quote
  13. Jul 18th, 2001, 04:59 AM #11
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    Ok thanks very much..I did chechk it out and indeed there are some useful things I can "use"...
    Reply With Quote Reply With Quote
  14. Jul 18th, 2001, 05:04 AM #12
    Mark Sreeves
    Mark Sreeves is offline
    Frenzied Member Mark Sreeves's Avatar
    Join Date
    Nov 1999
    Location
    UK
    Posts
    1,845
    Can you let me know if you find anything that's any good?

    Thanks
    Mark
    -------------------
    Reply With Quote Reply With Quote
  15. Jul 18th, 2001, 05:05 AM #13
    Kid_d
    Kid_d is offline

    Thread Starter
    New Member
    Join Date
    Jul 2001
    Location
    The Netherlands
    Posts
    7
    Sure...!!!!
    D.J. Engelhardt
    Software Engineer
    Reply With Quote Reply With Quote
  16. Jul 18th, 2001, 08:33 AM #14
    filburt1
    filburt1 is offline
    Member filburt1's Avatar
    Join Date
    Aug 1999
    Posts
    6,935
    Documentation is time costly, but when someone other than you looks at your code, it is the only thing standing between them and insanity.
    TurtleTips.com | My Forums
    Reply With Quote Reply With Quote
« Previous Thread | Next Thread »

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

Forum Rules


Click Here to Expand Forum to Full Width