Document your database schema using rich text memos
by Loïc Knuchel on
Hi again 👋, it has been a long time since the last post…
We were quite busy building awesome features, and now we are happy to release them. Expect more posts about recent improvements which drastically improved Azimutt.
Let’s start today by telling you about memos:
The database documentation part is always a pain, and we hope Azimutt could help with several features. Since the beginning you could see comments on tables and columns directly inside Azimutt diagrams and create layouts to showcase any relevant tables and columns for your goal. It can be a feature, a team scope or anything else.
Then we added notes on tables and columns. They are very similar to SQL comments but just stored in Azimutt project instead of your database. Much easier to update, less accessible for other tools.
And now we are introducing memos 🎉
They are small pieces of content you can freely place anywhere in your layout. And as they are rendered using markdown, you can really leverage them for rich layout documentation. For example, you could:
- link to other documentation or website
- add images for branding, highlighting some parts or even showing some emotions
- add SQL queries and sample result
- or any other creative idea or custom need you may have
To create a memo it’s really simple, just double click anywhere in your diagram background (or right click, also works 😉).
The first screenshot is a good example of what you can achieve with many Azimutt features, memos but not only and can be seen as overloaded but here is a more realistic documentation example, showcasing the Gospeak database schema:
I personally love the new capabilities offered by memos and I feel schema can be much easier to understand with a bit of text floating around. Tell us how you feel about them and don’t hesitate to share your realizations or improvements you can see, even minor ones like small UX trick 😉
If you want to play a bit with this new feature, here is the previous layout embedded, so you can move things and create new memos (but can’t save obviously ^^):
For now, this feature is limited to 1 memo per layout on free plan and, of course, truly unlimited for pro ones. We are just starting out so really don’t hesitate to reach at us if you think it’s too limited or the pro plan is not fine for you. We can easily find arrangements to make you succeed using Azimutt 🚀
Make a great use of these new shiny memos, but don’t abuse them ^^
See you soon on 🧭
Other blog posts
You might be interested in these other articles
[changelog] Get schema using database connection, JSON source and more
July: holidays and big change! You can now import your schema in Azimutt using a database connection, no need to export it yourself anymore. This is THE big change but not the only nice improvement, of the month.