Database Documentation

Accessibility Notice

This document is also available in HTML format at:

https://aholdengouveia.name/AdvData/labs/week6documentation.html

The HTML version provides enhanced accessibility features including keyboard navigation, screen reader support, responsive design, dark mode support, and high contrast options.

Objectives:

• Create some basic documentation for your database

Complete the following problems

References, a video, a PowerPoint and some notes are available at my website https://www.aholdengouveia.name/AdvData/databasedocumentation.html

You should continue to use the dataset you've already chosen, that you made the schema for. If you need to pick a new dataset please email to discuss it with me

For this lab, you should start thinking about this data as if it was for an actual company. What kind of company would want this data? What do they do? How do they make money? What is the size of the company?

Create your Documentation

Based on the data you picked, come up with a company that might use this data. This documentation should be for the company. The company can be any size, just make note of what size you pick. Some of this you may have from previous labs, but you should work on organizing it into your documentation here.

Your documentation can be done in any form you like, but if you're not sure consider using either MS Word or Google so that you can submit a PDF.

• Type of company and a sentence or two about what they might be doing, how they might make money, any other information that might be helpful.
• ER diagram or Schema
• List of rules for the data, including if there are any data types that are preset (i.e. years always being an integer)
• Data dictionary
• Backup plans, including onsite, offsite, validity checks and frequency.
• Version Control plan, including initial suggestion of what to use.
• Documentation update plan including schedule for when you think your documentation should be checked and why. Likely to be annually or quarterly

Deliverables

1. Document that includes answers to all the above questions. Document is likely to be long enough you'll need some variety of index, or table of contents, or shortcuts to the data. Your document needs to be sent in, you can also include a live link to a doc, but there must be a document uploaded that is static.