Results 1 to 7 of 7
  1. #1
    3 Star Lounger
    Join Date
    May 2002
    Location
    Toronto, Ontario, Canada
    Posts
    314
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Creating full documentation... (97 SR-2)

    Good Morning All... <img src=/S/smile.gif border=0 alt=smile width=15 height=15>

    Just curious... Does anyone know of a good template to use for database application documentation... I believe I've managed to do okay on my own so far, but I sometimes find myself wondering whether I'm missing something... I'm not talking about table or query specs... I know that Access has the documentor (although it's not the greatest)... I'm talking about everything from documenting the project details, analysis, test process, user guide, process flow, etc...

    Anyone have a favourite template or list that they follow?? Thanks everyone!

  2. #2
    Plutonium Lounger
    Join Date
    Mar 2002
    Posts
    84,353
    Thanks
    0
    Thanked 29 Times in 29 Posts

    Re: Creating full documentation... (97 SR-2)

    To my shame, I must admit that I don't really use a template. Instead, I copy and rename the documentation files for one project, rip out what I don't need, edit some things, and add what's needed. It may not be ideal, but it suits me, since many of the databases I design share a common structure and lots of code. (Of course, I had to assemble everything from scratch the first time, and there is some evolution over time, but all in all, it works for me)

  3. #3
    Super Moderator
    Join Date
    Aug 2001
    Location
    Evergreen, CO, USA
    Posts
    6,623
    Thanks
    3
    Thanked 60 Times in 60 Posts

    Re: Creating full documentation... (97 SR-2)

    There are some tools available from FMS (Total Access Analyzer) that do a very comprehensive job of documenting the details of a database design, but I don't know of any tools that exists that can be used to document processes, table design rationale, or user instructions.
    Wendell

  4. #4
    3 Star Lounger
    Join Date
    May 2002
    Location
    Toronto, Ontario, Canada
    Posts
    314
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Re: Creating full documentation... (97 SR-2)

    <img src=/S/laugh.gif border=0 alt=laugh width=15 height=15> That's okay Hans... Nothing to be ashamed of!... I think that most of us do the same as you are doing... Thanks!

  5. #5
    3 Star Lounger
    Join Date
    May 2002
    Location
    Toronto, Ontario, Canada
    Posts
    314
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Re: Creating full documentation... (97 SR-2)

    Thanks Wendell... <img src=/S/smile.gif border=0 alt=smile width=15 height=15>

    I truly wasn't hoping for a "tool" that does that much... I was more thinking of a template or a checklist with points on possible inclusions... Something that would prompt me for things that I'm possibly missing in my documentation... I think I'm going to start planning a utility application that will assist in documentation in more ways than just the technical specs.... I just thought that before I "re-invent the wheel", I'd ask what my peers do...

    Have a great day!

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

    Re: Creating full documentation... (97 SR-2)

    TechRepublic has many white papers and templates available after you sign up for a free membership. You might try there.
    Charlotte

  7. #7
    3 Star Lounger
    Join Date
    May 2002
    Location
    Toronto, Ontario, Canada
    Posts
    314
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Re: Creating full documentation... (97 SR-2)

    Thanks Charlotte... I'll check it out... <img src=/S/smile.gif border=0 alt=smile width=15 height=15>

Posting Permissions

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