How to document workflow/flow?

[major li]

Hi Community,

I am joining a new organization. I have observed that the developers here likes to go for complex customization over OOB. The workflow and flow are so long that it is not easy to change or to handover. 

May I know what is your practice to document the workflow so that it will support handover and troubleshooting?

Thank you. 

[YaswanthKurre · Accepted solution]

Hi @major li ,

Usually we can use Visual diagrams ( Microsoft Visio, lucid charts) or any other software  to help new developers quickly grasp the flow.

Mark this as helpful or correct if this helps you.

Thanks,

yaswanth

[major li]

hi @YaswanthKurre ,

thank you. how do you connect/store the document with the flow so that every time there is a change, developer will find it and update accordingly?

[J4wahar]

Hi @major li , 
As of now, we don't have such capability. We need to update the diagram manually. If you find this time consuming, try using an AI like ChatGPT or such. You can describe your process flow to it and ask for a mermaid diagram code. Once you have the code, go to mermaid.live to generate a diagram with the code.

If you find this helpful, please mark it as  helpful or correct

Thanks,

Jawahar

[YaswanthKurre]

Use internal documentation tool like confluence, where you can store your document with flow name.

Mark this as helpful or correct if this helps you.

Thanks,

yaswanth