Results 1 to 5 of 5

Thread: Documentation

  1. #1
    Gold Lounger
    Join Date
    Dec 2000
    Location
    Hollywood (sorta), California, USA
    Posts
    2,759
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Documentation

    I have read a few ads about auto documentation software for VB projects. Not sure if that applies to VBA as well, but my question is this:

    What tools are you using to document your development projects?

    What do you know about documentation software packages?
    Kevin <IMG SRC=http://www.wopr.com/w3tuserpics/Kevin_sig.gif alt="Keep the change, ya filthy animal...">
    <img src=/w3timages/blackline.gif width=33% height=2><img src=/w3timages/redline.gif width=33% height=2><img src=/w3timages/blackline.gif width=33% height=2>

  2. #2
    Plutonium Lounger
    Join Date
    Dec 2000
    Location
    Sacramento, California, USA
    Posts
    16,775
    Thanks
    0
    Thanked 1 Time in 1 Post

    Re: Documentation

    What kind of documentation are you referring to? I use Visio for a lot of the structural stuff in databases. You can build a data dictionary in Excel very nicely, and code modules can be printed as is or exported to text files that can be formatted in Word. If you comment your code thoroughly and use naming conventions and some kind of procedure separator, the code should be pretty much self-documenting. VB is a bit different from VBA projects because each of its modules and forms is a separate file, so documentation would probably require a somewhat different approach.
    Charlotte

  3. #3
    2 Star Lounger
    Join Date
    Dec 2000
    Location
    eastern Connecticut, Connecticut, USA
    Posts
    113
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Re: Documentation

    Do you have an example or template of how your data dictionary is constructed in Excel?

    TIA...

  4. #4
    Plutonium Lounger
    Join Date
    Dec 2000
    Location
    Sacramento, California, USA
    Posts
    16,775
    Thanks
    0
    Thanked 1 Time in 1 Post

    Re: Documentation

    Actually, one of the best templates I've seen for that came with Stan Leszynski's book, Access 97 Expert Solutions. I don't usually go as far as he did, but Excel is handy for this because you can separate field names, table names, data types, descriptions, etc., into outlines that can be collapsed or expanded appropriately. Makes it a lot easier to look at, and the annotation capability is nice.

    I also have an Access data dictionary demo that I'm seeking permission to provide a link to. I'll let everyone know if the author is agreeable.
    Charlotte

  5. #5
    Plutonium Lounger
    Join Date
    Dec 2000
    Location
    Sacramento, California, USA
    Posts
    16,775
    Thanks
    0
    Thanked 1 Time in 1 Post

    Re: Documentation

    The author of the Data Dictionary was agreeable, so here's the link if anyone wants to look it over http://208.45.224.186/masq/Demo/index.htm. Please note that this is freeware and comes with no guarantees.
    Charlotte

Posting Permissions

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