| Ideas | - Maybe include a list of fields but not descriptions of those fields? Or should it also have field descriptions?
- Also from Tod, after another SIG discussion: This morning in the Reporting SIG we talked briefly about ways to document the derived tables. I'd mentioned maybe there's a way to create the documentation in the SQL and then generate something legible and easy to reference. In looking for pre-existing solutions, a couple searches that I found useful were "how to document tables in sql comments" and "sphinx sql documentation". This at least seems to be a problem that others have wrestled with, so we may be able to lean on or draw inspiration from prior work.
- (Also look for notes in SIG meetings from August/September)
- Also, how the tables connect to other tables? maybe a small ER diagram with foreign key relationships?
|
