from Hacker News

Documenting Your Database Schema

by MaxGabriel on 8/9/24, 1:32 PM with 1 comments

  • by MaxGabriel on 8/9/24, 1:32 PM

    I think database schema docs are really valuable, so much so that I added tests that require docs for each table and column. But I still got asks that the docs needed more information, mostly from data science people (who otherwise need to go bug engineers, or end up writing bugs in their own SQL). So I wrote internal guidelines for documenting database tables, and eventually that became this blog post

    Lemme know if you have any questions!