Sign Up

Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.

Have an account? Sign In

Have an account? Sign In Now

Sign In

Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.

Sign Up Here

Forgot Password?

Don't have account, Sign Up Here

Forgot Password

Lost your password? Please enter your email address. You will receive a link and will create a new password via email.

Have an account? Sign In Now

You must login to ask a question.

Forgot Password?

Need An Account, Sign Up Here

Please briefly explain why you feel this question should be reported.

Please briefly explain why you feel this answer should be reported.

Please briefly explain why you feel this user should be reported.

Sign InSign Up

The Archive Base

The Archive Base Logo The Archive Base Logo

The Archive Base Navigation

  • Home
  • SEARCH
  • About Us
  • Blog
  • Contact Us
Search
Ask A Question

Mobile menu

Close
Ask a Question
  • Home
  • Add group
  • Groups page
  • Feed
  • User Profile
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Buy Points
  • Users
  • Help
  • Buy Theme
  • SEARCH
Home/ Questions/Q 88117
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Editorial Team
Asked: May 10, 20262026-05-10T22:30:33+00:00 2026-05-10T22:30:33+00:00

(Note: I realize this is close to How do you document your database structure?

  • 0

(Note: I realize this is close to How do you document your database structure? , but I don’t think it’s identical.)

I’ve started work at a place with a database with literally hundreds of tables and views, all with cryptic names with very few vowels, and no documentation. They also don’t allow gratuitous changes to the database schema, nor can I touch any database except the test one on my own machine (which gets blown away and recreated regularly), so I can’t add comments that would help anybody.

I tried using "Toad" to create an ER diagram, but after leaving it running for 48 hours straight it still hadn’t produced anything visible and I needed my computer back. I was talking to some other recent hires and we all suggested that whenever we’ve puzzled out what a particular table or what some of its columns means, we should update it in the developers wiki.

So what’s a good way to do this? Just list tables/views and their columns and fill them in as we go? The basic tools I’ve got to hand are Toad, Oracle’s "SQL Developer", MS Office, and Visio.

  • 1 1 Answer
  • 0 Views
  • 0 Followers
  • 0
Share
  • Facebook
  • Report

Leave an answer
Cancel reply

You must login to add an answer.

Forgot Password?

Need An Account, Sign Up Here

1 Answer

  • Voted
  • Oldest
  • Recent
  • Random
  1. 2026-05-10T22:30:34+00:00Added an answer on May 10, 2026 at 10:30 pm

    In my experience, ER (or UML) diagrams aren’t the most useful artifact – with a large number of tables, diagrams (especially reverse engineered ones) are often a big convoluted mess that nobody learns anything from.

    For my money, some good human-readable documentation (perhaps supplemented with diagrams of smaller portions of the system) will give you the most mileage. This will include, for each table:

    • Descriptions of what the table means and how it’s functionally used (in the UI, etc.)
    • Descriptions of what each attribute means, if it isn’t obvious
    • Explanations of the relationships (foreign keys) from this table to others, and vice-versa
    • Explanations of additional constraints and / or triggers
    • Additional explanation of major views & procs that touch the table, if they’re not well documented already

    With all of the above, don’t document for the sake of documenting – documentation that restates the obvious just gets in people’s way. Instead, focus on the stuff that confused you at first, and spend a few minutes writing really clear, concise explanations. That’ll help you think it through, and it’ll massively help other developers who run into these tables for the first time.

    As others have mentioned, there are a wide variety of tools to help you manage this, like Enterprise Architect, Red Gate SQL Doc, and the built-in tools from various vendors. But while tool support is helpful (and even critical, in bigger databases), doing the hard work of understanding and explaining the conceptual model of the database is the real win. From that perspective, you can even do it in a text file (though doing it in Wiki form would allow several people to collaborate on adding to that documentation incrementally – so, every time someone figures out something, they can add it to the growing body of documentation instantly).

    • 0
    • Reply
    • Share
      Share
      • Share on Facebook
      • Share on Twitter
      • Share on LinkedIn
      • Share on WhatsApp
      • Report

Related Questions

Loading...

Sidebar

Ask A Question

Stats

  • Questions 54k
  • Answers 54k
  • Best Answers 0
  • User 1
  • Popular
  • Answers
  • Editorial Team

    How to approach applying for a job at a company ...

    • 7 Answers
  • Editorial Team

    How to handle personal stress caused by utterly incompetent and ...

    • 5 Answers
  • Editorial Team

    What is a programmer’s life like?

    • 5 Answers
  • added an answer No. You cannot use bind variables for table or column… May 11, 2026 at 7:23 am
  • added an answer If you believe in DDD, it's perfectly fine to know… May 11, 2026 at 7:23 am
  • added an answer REPLACE(column, 'KB', ''). No need for LEN and other stuff… May 11, 2026 at 7:23 am

Top Members

Trending Tags

analytics british company computer developers django employee employer english facebook french google interview javascript language life php programmer programs salary

Explore

  • Home
  • Add group
  • Groups page
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Users
  • Help
  • SEARCH

Footer

© 2021 The Archive Base. All Rights Reserved
With Love by The Archive Base

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.