What is your goal?
Detailed documentation for scenarios using tools in Make.
What is the problem & what have you tried?
Documentation creation for scenarios
Export the scenario blueprint mad feed it to Claude for documenting.
A more advanced way will be to add Claude skills.
An even more advanced way would be to create a Make scenario and use an agent to pull the scenario blueprint, some execution logs and based on the knowledge provided, document the scenario.
Hi @Ganesh1
There are a few ways I create documentations using tools in make depending on what you intend to use it for.
For very basic non logging documentation i.e. information that you use on the go, there’s an add notes option that allows you to describe exactly what you’re doing and how it’s going. This is manual and you don’t log anything anywhere you just just open your notes and update it with What you’re currently doing. You can also rename all your modules and give them very descriptive names and even add module to module descriptions that can be very handy and makes the scenarios easy to debug and resuse. Another hack that might need an external tool is to export your scenario blueprint and feed it to an AI and analyze it and document as deep as needed.
If this doesn’t satisfy the question then read further.
On the other hand if you need a general or a deeper level scenario documentations that comes with adequate logging or producing external documentats, one of the best way is to use an AI agent although it could still get extremely manual depending on the depth of the documentation (workflow, dataflow, impact, automatic documentations for every scenario run, etc.)
-Using an AI moduke/Agent:
Let’s say we’re dealing with a scenario that is a basic email support scenario and watches a mailhook for incoming emails to trigger it, then triages the email into 4 categories (business casual, business support, business escalation and business irrelevant), then it responds only to business casual and business support. It then sends “business escalate” to Slack for human response and completely ignores business irrelevant emails. The scenario then logs every successful response into your Google sheets database and irrelevant emails logged on anoher sheet..
NB: All what I have written so far in the point above can be a standalone documentation of the scenario workflow). But let’s take it a few steps further to module to module documentation.
The modules we are dealing with right here are:
Or if we’re not using sheets we can append our per run documentation into a Google docs. We repeat the same for all 4 branches the Slack branch has the forst AI module generate a Slack response and a Slack module to forward it to Slack followed by the documentation module and the logging module. The invalid branch might only send an email informing the scenario owner of an invalid email and the documentation ai module plus the logging module.
This looks hectic, manual, and monotonous but the outcome can be magnificent if you’re dealing with extremely high stakes customers like maybe legal advice, finance, or medical related services. Per run documentation will tell you everything that happened when every single customer got a response from your scenario and the documentation agent might even capture errors in operational inefficiencies.
So with Make the possibilities cab be endless but since the question seems a little ambiguous, a deeper case by case answer should cover most use cases using Make tools for documentation. Hopefully if profitable, in the future make might roll out run by run documentation features for a toggle on documentation experience for enterprises and maybe teams.
Regards.