Documentation for large Bubble app

Hi All,

Just an open question to all of you:
How do you organise the documentation of your Bubble app?

We are working with a Team of already 7 on 1 very large complex app and thus documentation becomes more and more important, also when onboarding new developers, but also just with our current developers. An small example: A certain workflow for creating session is pretty simple to find and understandable if you check it out in the Bubble app. However, it is pretty hard to know that we use database triggers to update that session’s status, which could have a huge impact on the feature/bug fix that the developer is implementing.

Therefore we want to build an exhaustive documentation of our total Bubble app. We already have used bubble internal notes features, video walkthroughs but that’s too scattered. Especially the focus on the entanglements between workflows, BWF, APIs and Database triggers needs to be clear, so that a developer can easily see what their impact is when they are changing something.

I have seen some notion templates, but that’s about it.

So very curious what you use: which tools, procedures…

Thanks and have a great day

2 Likes

i’d be interested as well. I personally use a notion template, but i’m one person and my app isn’t that complex.

2 Likes

some advanced tool helps developers to generate a lot of initial documentation from the inside system or application I hope bubble one-day help developers by auto-generate some of the documentation for the Application

2 Likes

Here are few practices that I follow:

  1. Maintain a centralised documentation hub on Confluence. Notion is also great, but I prefer confluence as I use JIRA for product management.
  2. Split documentation into sections, such as workflows, database structure, API integrations, and more to keep things organised and easy to navigate.
  3. Usually I structure documentation at App level > Feature level > Workflow level.
  • And for each level, I try to keep detailed documentation on how it works, what it does, and any dependencies it may have with other parts of the app. I also include screenshots or videos of the workflow in action, as well as any relevant links to APIs or external services.
  • Database structure including tables, fields, and relationships between them. This also includes information about any database triggers or actions that may affect the app’s functionality.
  • Diagrams or flowcharts to illustrate complex workflows or features, which can be especially helpful when onboarding new team members.
  1. I also maintain a documentation around naming convention used in the app, so that the consistency is followed everywhere and new developers can also start following that.
  2. Last but not least keep everything updated. :slight_smile:
3 Likes

I’m using Notion and Confluence. Confluence is free for a small team (up to 10 people).

1 Like

We use Monday.com for app development tracking, defect reporting & evolution request tickets, testing, and evolution rollout planning. I believe you can also create workflows in it but have not done so yet. We also use this tool for all our project management, making it easy to see cross-department needs and timelines. Pricing is very affordable and nonprofits can get free accounts for up to 10 users.

1 Like

@elizabeth2 - we do use Monday.com as well for our ticket/project management stuff. It can do a lot, but sometimes is a bit of a mystery to us how it behaves. How do you manage your app documentation?

1 Like