How is your experience with the OutSystems Community?
10
Views
0
Comments
AI tool that generates client-ready handover docs from your OML - sample inside

7 years doing OutSystems projects and I've written the same documentation more times than I can count. Data model, Server actions, Screens, Integrations, Timers, Roles, Site properties. Every handover for every client. Always at the end of the project when everyone's exhausted and the deadline was yesterday.

And every project starts the same way every time, this time we'll keep it updated as we go, no last-minute scramble. Then the work piles up, priorities shift and somehow I'm back in the same place writing it all from scratch the night before the handover.

I've used OutDoc. It's useful for what it does - but if you've used it seriously you know the gaps. Screen documentation is basically non-existent beyond listing screen actions. Comments inside Screen Actions don't show up. What you get is structure without context - a skeleton, not a document you'd actually hand to a client.

Two years ago someone asked in this forum if OutDoc could export to PDF and have it look like a well-formed document. The answer was "not possible, post it as an idea." Someone replied "this is needed." Nobody built it, so I did.

OML in, XML downloaded, XML uploaded, PDF out.

It takes your OML file, extracts the module metadata as XML, and runs it through AI to generate a formatted PDF - the kind you'd actually hand to a client or drop in Confluence. Not a raw dump, an actual readable document.

Sample output attached - fictional hotel management project, but built from realistic OutSystems structure so you get a real sense of it. Note that this is an early version of the PDF - the layout, text and styling can still be improved, but the content is the point.

One thing that surprised me: even with zero descriptions in Service Studio, the output is already readable. The sample attached was generated from a module where nothing was described - the AI infers context from element names, folder structure, and relationships, add proper descriptions and it gets even better, but it's useful out of the box.

A few questions:

  1. Is this actually a pain for you, or do you have a process that works?
  2. What would you add or remove for your typical handover?
  3. How many OutSystems projects do you deliver per month?
  4. If this was available as a hosted tool, would you use it?
VistaHMS_Core_Documentation.pdf
Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.