• Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Part: VI Appendixes > Documenting the Relationships Graph

Documenting the Relationships Graph

The Relationships Graph does not have a built-in feature for adding comments or descriptions. However, there are a few things you can do to document the Relationships Graph. Always make table occurrence names descriptive and follow a consistent naming scheme. Some developers like to begin the name of a table occurrence with the name of the source table. This practice can be quite helpful when selecting a table occurrence from a list. Table occurrences are alphabetized when displayed in a list, and therefore all occurrences for a particular table that use that naming convention are grouped together in the list.

You also might want to use color to develop a scheme that adds meaning to table occurrences. Table occurrences for data tables, utility tables, and system tables can have different colors. You might also choose to use color to differentiate each table occurrence group. The HTML and XML versions of the Database Design Report include the color of the table occurrences, and display that color in the report output. You can add more table occurrences as group headers or comments. See the example in Figure D.2. A table occurrence name can contain up to 100 characters. The Relationships Graph can be spread across many pages if this is helpful for readability. Use plenty of whitespace and place logical groups of table occurrences on separate pages to make large Relationships Graphs easier to understand and maintain.


PREVIEW

                                                                          

Not a subscriber?

Start A Free Trial


  
  • Creative Edge
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint