Results 1 to 14 of 14

Thread: documentation

  1. #1
    Join Date
    Jan 2003
    Location
    India
    Posts
    523

    Unanswered: documentation

    hello everyone,
    I have to document about four databases, has anyone got any specific format or tool for documenting a database?
    Any inputs would be very helpful
    regards,
    Harshal.

  2. #2
    Join Date
    Aug 2002
    Location
    Scotland
    Posts
    1,578
    I've used this tool earlier.
    --Satya SKJ
    Microsoft SQL Server MVP
    [IMG]http://sqlserver-qa.net/google_bart.gif[/IMG]

  3. #3
    Join Date
    Jan 2003
    Location
    India
    Posts
    523
    Originally posted by Satya
    I've used this tool earlier.
    thanks for the quick reply,
    but I have to write in details about the use of the table and the logic used in the stored procs also.
    I'll go thru the software, is there any specific format for documenting?

    Regards,
    Harshal.

  4. #4
    Join Date
    Aug 2002
    Location
    Scotland
    Posts
    1,578
    I think with the help of VISIO also you can accomplish the task.
    As of I know there is no specific format as such, it depends how easy you document.
    --Satya SKJ
    Microsoft SQL Server MVP
    [IMG]http://sqlserver-qa.net/google_bart.gif[/IMG]

  5. #5
    Join Date
    Jan 2003
    Location
    India
    Posts
    523
    Originally posted by Satya
    As of I know there is no specific format as such, it depends how easy you document.
    yeah i guess it is so.

    but really, documentation is third grade torture.

  6. #6
    Join Date
    Aug 2002
    Location
    Scotland
    Posts
    1,578
    Shame is no compatible tools available to document the database, rather we should depend upon third party supplied tools.
    --Satya SKJ
    Microsoft SQL Server MVP
    [IMG]http://sqlserver-qa.net/google_bart.gif[/IMG]

  7. #7
    Join Date
    Jan 2003
    Location
    India
    Posts
    523
    Originally posted by Satya
    Shame is no compatible tools available to document the database, rather we should depend upon third party supplied tools.
    I beg to god for an intellegent tool which would also document all my procedures and their logic

  8. #8
    Join Date
    Jul 2003
    Location
    The Dark Planet
    Posts
    1,401
    You will have to wait for next version of SQL Server after Yukon .. they might add it by then
    Get yourself a copy of the The Holy Book

    order has no physical Brett in The meaning of a Kaiser . -database data

  9. #9
    Join Date
    Nov 2002
    Location
    Jersey
    Posts
    10,322
    Documentation, is documentation.

    It is painful.

    If the code's not clean, it's even more painful.

    Sorry...been there, done that.


    PROC NAME:

    Purpose:

    Inputs:

    Outputs:

    Process flow:

    And that's just the sprocs...

    Do you need to a data model as well?

    What about an application process model?


    And what did you do wrong to get this assignment?
    Brett
    8-)

    It's a Great Day for America everybody!

    dbforums Yak CorralRadio 'Rita
    dbForums Member List
    I'm Good Once as I ever was

    The physical order of data in a database has no meaning.

  10. #10
    Join Date
    Mar 2004
    Location
    New Jersey
    Posts
    9

  11. #11
    Join Date
    Sep 2003
    Posts
    522
    documentation is already there, basic, maybe even primitive, but is there, in diagrams. if one was too lazy to write it as the app was being developed, doing it when everything else is done is going to be a project in itself. when this is the situation, you can use something as simple as copy con from dos prompt, or as sophisticated as robohelp office or er/studio or visio. the tool does not make any difference for as long as features of the tool will adequately describe what you got.

  12. #12
    Join Date
    Jan 2003
    Location
    India
    Posts
    523
    Originally posted by Brett Kaiser
    Documentation, is documentation.

    It is painful.

    If the code's not clean, it's even more painful.

    Sorry...been there, done that.


    PROC NAME:

    Purpose:

    Inputs:

    Outputs:

    Process flow:

    And that's just the sprocs...

    Do you need to a data model as well?

    What about an application process model?


    And what did you do wrong to get this assignment?


    yeah the format is jsut similar to what i am currently using.
    The real thing is in the process flow at places the code is worst this part is driving me crazy.
    The application process model is to be documented by another guy
    but yeah i do have to have the data flow diagrams

    what i do wrong???
    well that is a question i am been thinking of since yesterday

  13. #13
    Join Date
    Nov 2002
    Location
    Jersey
    Posts
    10,322
    Well, in all honesty, walking in to a piece of sh-t system with no dco, is what a hired gun is all about.

    If you can figure the sh-t out, you can do anything.

    And yes, I always start with a data flow digram...

    Gives a very clear picture of what's going on...

    It's a higher level, but it gives you everything you need to then focus on the details...

    Make sure that the diagram identifies the data, a process and the output of that process


    There is no need to define the process in detail, just a descriptive name for a process...

    It's a good way to define a road map to attack the details...

    The devil is, as they say, in the details

    That will come soon enough

    But until you get a picture, it's a forect through the trees kinda thing

    oh, and a big MOO
    Brett
    8-)

    It's a Great Day for America everybody!

    dbforums Yak CorralRadio 'Rita
    dbForums Member List
    I'm Good Once as I ever was

    The physical order of data in a database has no meaning.

  14. #14
    Join Date
    Jul 2003
    Location
    San Antonio, TX
    Posts
    3,662
    Brett does diagrams...

Posting Permissions

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