Forum Academy Marketplace Showcase Pricing Features

Documentation Template?

I am building my app and it’s getting a bit complicated.

Does any expert developer here knows of a good documentation guideline or template one should/can use to document everything about one’s app including database, workflows, styles, etc?

I use gitbook
https://gitbook.io

1 Like

AirTable is a good one for development that I use to keep track of stuff

1 Like

Thanks @johnny I understand Airtable, Gitbook, Notion, etc. are good platforms for documentation.

What I am looking for is the template showing what to document and how to document so that the handover of app becomes easier.

Ah I see, yes. So this was a thing I struggled with, but when I got settled with AirTable, they have templates they give you and you can just rename them to Styles, Workflows, Pages, To-Do (if you wish, I use Trello and their power ups for this), etc.

I personally don’t prefer Gitbook for internal documentation for development, it’s better user-ended in my opinion.

I believe this one is the one I use: Project Tracker Template - Free to Use | Airtable

1 Like

So you prefer a structured/hierarchical layouts for documentation? For instance, database>Data Type>>Thing1, Thing2, etc followed by your notes for each. If yes, how do you maintain documentation for workflows?

Hey @myflappd,

So I don’t actually personally track any Styles, Workflows or Data Types. I track pages and individual tasks that need to be completed per page.

1 Like

Thanks @johnny . That’s very helpful.

However, if you’re planning the structure of your database, this documentation by @AirDev is helpful: https://docs.airdev.co/bubble-development-guide/steps/plan/database-structure

2 Likes