structure and organization of Firestore collections: documentation
Normally documentation about collections is done in a 3rd party tool like notion, jira, google docs (or notepad for the brave ones).
After a while this easily becomes inconsistent due to ongoing changes throughout the project development. The same way as we document code directly in the code file, it'd be great to document collections directly in the firestore console.
For this, something simple like a text input would suffice (ideally with some minimal markdown, but not mandatory). If developers need to add more detailed info or explanations (and make use of charts, designs, videos, whatever) they could simply add a link and direct to their favourite documentation tool.
This documentation would be useful to add information about
- collection structure
- document versioning (very important in NO-SQL when changes in structure happen between app versions)
- triggers and updates with cloud functions (eg first document is written, then triggers a cloud function that does X, and document gets updated with information Y