Great question @matt3. I’m eager to hear what other people in the community have done.
I predominantly use the notes field for each page to summarize how the page works and to document any of the gotchas and rational for architectural decisions. I keep these high level which means they’re 1 paragraph for a simple page and maybe 10 paragraphs for a really complex page with multiple layers of content. Then, I look back at the “code” for more detailed level information on how it works when needed.
We’ve also diagramed our database and shown the links betweeen tables, etc. This was useful early on, but I’ve used the database so much now that it’s pretty well internalized. That said, the documentation has been helpful anytime we bring on a consultant to advise and will be valuable when we onboard additional team members.
A few things I would find useful are:
- Visual Database Diagrams that update as our database updates
- Tools to help me clean out unused pieces of our app (e.g., unused hidden elements, unused database fields or database fields where we collect data but don’t display it anywhere, objects on page that are always hidden or haven’t been triggered/shown in over a month, etc.)
Curious to hear how other people are approaching this and any best practices / lessons learned.