Database Dictionary Audit for Manage:Optimize

Recently the database team has started documenting all database tables in db/doc. As an MVP, we've assigned each table to a feature category. We attempted to automate this, and then made rough guesses on the ones that couldn't be automatically identified either using this spreadsheet or just by guessing based on their name and code references. In order to make sure these are accurate, I'm asking every team to take a look at the tables associated with their feature categories assoicated with their stages.

What we need from your team? Look through the list of tables and fix any mistaken labels and update the description field to help folks know what purpose the table serves.

Process (per table)

1. Are the feature categories correct?
   • Keep in mind that tables can have multiple categories. Look at the list and if there are any other categories it belongs to, add them.
   • If a table has no category that seems to be a perfect match, assign it to the closest match. Tables must have at least one feature category.
   • If the table is assigned to a feature category for a different group, open a merge request changing the category and assign it to the EM for the group responsible for that category.
2. Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
3. Double check the milestone and introduced_by_url to see if they are accurate

Tables

• analytics_devops_adoption_segments

  • devops_reports is the correct feature category or has been updated
  • analytics_devops_adoption_segments description has been updated
  • analytics_devops_adoption_segments milestone and introduced_by_url seem accurate

• conversational_development_index_metrics

  • devops_reports is the correct feature category or has been updated
  • conversational_development_index_metrics description has been updated
  • conversational_development_index_metrics milestone and introduced_by_url seem accurate

• analytics_devops_adoption_snapshots

  • devops_reports is the correct feature category or has been updated
  • analytics_devops_adoption_snapshots description has been updated
  • analytics_devops_adoption_snapshots milestone and introduced_by_url seem accurate

• fork_networks

  • devops_reports is the correct feature category or has been updated
  • fork_networks description has been updated
  • fork_networks milestone and introduced_by_url seem accurate

• analytics_language_trend_repository_languages

  • devops_reports is the correct feature category or has been updated
  • analytics_language_trend_repository_languages description has been updated
  • analytics_language_trend_repository_languages milestone and introduced_by_url seem accurate

• analytics_usage_trends_measurements

  • devops_reports is the correct feature category or has been updated
  • analytics_usage_trends_measurements description has been updated
  • analytics_usage_trends_measurements milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_issue_stage_events

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_issue_stage_events description has been updated
  • analytics_cycle_analytics_issue_stage_events milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_group_value_streams

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_group_value_streams description has been updated
  • analytics_cycle_analytics_group_value_streams milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_merge_request_stage_events

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_merge_request_stage_events description has been updated
  • analytics_cycle_analytics_merge_request_stage_events milestone and introduced_by_url seem accurate

• merge_request_metrics

  • value_stream_management is the correct feature category or has been updated
  • merge_request_metrics description has been updated
  • merge_request_metrics milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_project_stages

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_project_stages description has been updated
  • analytics_cycle_analytics_project_stages milestone and introduced_by_url seem accurate

• insights

  • value_stream_management is the correct feature category or has been updated
  • insights description has been updated
  • insights milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_group_stages

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_group_stages description has been updated
  • analytics_cycle_analytics_group_stages milestone and introduced_by_url seem accurate

• dora_daily_metrics

  • value_stream_management is the correct feature category or has been updated
  • dora_daily_metrics description has been updated
  • dora_daily_metrics milestone and introduced_by_url seem accurate

• events

  • value_stream_management is the correct feature category or has been updated
  • events description has been updated
  • events milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_stage_event_hashes

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_stage_event_hashes description has been updated
  • analytics_cycle_analytics_stage_event_hashes milestone and introduced_by_url seem accurate

• analytics_cycle_analytics_aggregations

  • value_stream_management is the correct feature category or has been updated
  • analytics_cycle_analytics_aggregations description has been updated
  • analytics_cycle_analytics_aggregations milestone and introduced_by_url seem accurate

• issue_metrics

  • value_stream_management is the correct feature category or has been updated
  • issue_metrics description has been updated
  • issue_metrics milestone and introduced_by_url seem accurate

Why is this effort happening?

There have been many times that issues occur in production, but the the infrastructure team doesn't have the information it needs to identify subject matter experts who can help resolve things quickly. This in turn can delay the time it takes to find and fix pressing issues.

How much time should we expect to spend on this?

Depends, if the team has a lot of tables, it may take a little bit to get all of the information together. If not, this could be very fast. The descriptions are as much or little as the team wants to add. More information may help folks self service better.

How urgent is this?

The urgency is up to the team. If the tables have poor information or are misassigned, that may cause more burden on the team when answering questions.