App Documentation

[omar2]

Dear All,

Im trying to write a proper app documentation such as a handover documentation for a bubble app, are there any guidelines that i can follow, or if someone knows how, please help.

Best Regards,
Omar Fakieh

[J805]

I think there are a few ways to do this:

1. Create notes in your bubble app. The little at the top of elements and workflows.

2. Create a book type of documentation like https://manual.bubble.io/

3. Create a video walkthrough/tutorial.

4. Create a walkthrough like this https://bubble.io/plugin/walkthrough--onboarding-tour-1524608392042x800431650188820500 or https://bubble.io/plugin/hopscotch-step-by-step-tours-1531522528474x300804982411100160 For your actual app.

Hope that helps!

@j805 www.NoCodeMinute.com

For All Your No-Code Education Needs:

• One-on-One Tutoring
• eLearning Hub
• Video Tutorials
• No-Code Classes

[omar2]

Thanks J805 for your reply, for creating a book type of documentation, are there any guidelines that i should follow?

From what i know we can have two types of documentation, user documentation and technical documentation, in the user documentation it will be how the website actually work and what are the pages that are included in it, for the technical however, im not sure what i should include, should i include all the workflow that has been done for each section for example., or how would i go about it?..

Thanks again,
Omar Fakieh

[J805]

@omar2 It really depends what your ultimate goal is. Is this a template for sale? Do you need documentation for developers? What do the users of your application need to do? Would it be easier to just create a video or a step-by-step tour?

There are a lot of ways websites onboard new users. Here is a list of great onboarding examples: https://www.reallygoodux.io/categories/user-onboarding

I think you should ask your users, or potential users, what documentation they will want/need. Always best to get it straight from the source.

Anyways, that’s just my suggestion.