Interpreting an FME model can be challenging at times, so having a function that exports every transformer/tool used in the model and automatically providing an interpretation of their actions would be helpful. Is this possible in FME?
Question
Is there a way to automatically generated a documentation file from a workbench workflow?
+61
I know some users have designed this. You can make use of the workspace reader to create something like it. I believe they used bookmarks and transformer naming standards to make it readable.
I know some users have designed this. You can make use of the workspace reader to create something like it. I believe they used bookmarks and transformer naming standards to make it readable.
Documentation for the FMW reader: https://docs.safe.com/fme/html/FME-Form-Documentation/FME-ReadersWriters/fmw/fmw.htm
+61- Celebrity
I do think it requires the developer to properly document the workspace. Any kind of automated system can probably tell you what is being done, but not why. And the why is at least as important, maybe even more.
I’ve experimented with a different approach: renaming the .fmw to .xml and running it through an AI prompt. The result is a Markdown doc of inputs, outputs, and step-by-step logic, written in general ETL terms.
Of course, this doesn’t capture the “why” behind a workflow (that still requires proper annotations inside), but it can be a quick way to share the “what/how” of a workspace as a quick overview or for colleagues who don’t use FME.
Just sharing in case it’s useful for others exploring documentation options:
https://www.linkedin.com/pulse/automatically-document-any-fme-workflow-using-ai-2-steps-alegre-7zzqf
+61- Celebrity
I've had pretty good experiences with using the AI Assist in Workbench (2025.1 and higher), simply asking it “what does this workspace do” usually comes up with a pretty good description. Still the what and not the why of course, but it's a good start.
FME rocks! \m/