Documenting Fusion Scenarios

[jayciedido]

Hi all!

I've been working on documenting our company's fusion scenarios and keep going back and forth on the best way to capture all the information. I'm currently using an excel sheet where each cell is a module's inputs and outputs, but it's a lot to look at and can get confusing.

I was wondering if anyone has a way to document scenarios that they like? Preferably easy to create/maintain and read, if possible! 

[Erika_Antkowiak]

Hi @jayciedido! We purchased Fusion this last year and built our first couple scenarios so this is top of mind. We were able to work with a vendor to help us think through our scenarios and teach us the ropes. We also requested in-depth documentation from the vendor to outline each scenario before the engagement ended. They created a Word document that outlined each scenario including images of all modules, their use, error handling, etc. in an easy to understand format. I'd recommend you do the same in Word that way you can not only outline each module in each scenario, but you could also easily add tips/tricks/watch points that can help the reader in the future. Clear documentation is a must! Let me know if this helps or if you have any additional questions. I'm always happy to help!

[AhmedEl]

Hi @Erika_Antkowiak , I couldn't agree more. Documentation is a absolute must, especially as the volume of Fusion scenarios grows.

Without it, you risk losing the 'institutional memory' of what was built and, more importantly, why it was configured a certain way—which becomes a major pain point during staff transitions or when scaling the team.

Since you’ve had success with the Word format, I’d love to hear more about your structure. Would you be open to sharing a few more details on how those documents are laid out? For instance, do you organize them by business process, or do you focus more on the technical mapping of individual modules? It would be great to see how others are standardizing this!

[Erika_Antkowiak]

Hi @AhmedEl, 

We are on the same wavelength. Documentation is key when transitions happen (internal or implementation hand off), but also when errors arise. Documentation can act as a map and allow the team to pinpoint problems, solutions or opportunities for improvement. I'm happy to share an outline of our documentation structure - see below.

Scenario Overview

• Provide basic scenario information that may need to be referenced across time as teams or processes change
  • Name, URL, Objective, Trigger, etc.

Step-by-Step Outline

• Explain each step in the scenario (the what, how, when, why)
  • Include screen shots, route differences, etc. 

Maintenance & Error Handling

• Watch Points
• Known Errors
• Ongoing Maintenance or Known Updates

Best,

E

[Lawson02]

Per my question in forums I am moving away from hand written documentation and trying to use AI for this as documenting and maintaining 80+ scenarios is too tedious. I am looking to create a scenario that reads all information about a scenario and populates an AI chatbot to assist me with this. I will be reading all information about a scenario including Webhooks, scenario JSON, and notes.

[NickVa11]

Hi all - 

I recently had the same arduous task of documenting all of our Fusion scenarios.  I kept spinning my wheels on the best way to do it without it being confusing.

I downloaded each scenario blueprint and fed each one through AI, asking it to create technical documentation with the ability for a novice tech user to understand it, and I asked it to outline what each scenario does.  The result was great...not to mention super quick.

[Sven-iX]

Ha! First legit and successful use of LLM!! 

I tried chatgpt (meh) and claude.ai (great) - I think I might begin using this going forward:

you're a technical writer and will create documentationin MS Word based on an Make/Integromat scenario JSON 
the audience are business users who need to understand the flow, logic branches etc of the scenario.
Then, using white background and black text, create
-          a high-level diagram of the flow
-          a simplified flow showing only main paths
-          a sequence diagram
attached is the JSON (upload the file)

Note - the exported JSON is "prettified" and has a TON of whitespace. you can reduce the file size 90% be removing line breaks, tabs and multiple spaces.