0

As the title suggests, what is the easiest way to document a Salesforce environment, in particular Apex Code and Flows. I've been looking at ApexDoc, but this has not been maintained for the last few years, so I am concerned there maybe challenges with using this an newer Apex functionality - it also appears this does not document flows.

Ideally I am looking for a tool that I can add into a build pipeline that documents all flows, and Apex methods, including inputs and outputs. This will then allow me to create a catalogue of 'services' that are then reusable by my developers as we build more and more customisation.

Improve this question

2 Answers 2

Reset to default
2

We use SfApexDoc, a variant of the standard ApexDoc documentation generator, which was recommended by Scott Wells, the author of Illuminated Cloud (the IDE we use), to generate our "Public API documentation" directly from our Apex code (selected global classes). Whilst this also hasn't been updated in GitLab for years, it works fine for us since we focus on the API aspects (i.e. global interfaces, classes, methods, properties and attributes) which haven't really changed in later platform releases.

As for flows, doing an internet search shows you that there's no OOTB documentation generator for these at the moment.

Improve this answer
2
  • Thanks Phil - I was drawing a blank as well when searching for something to document flows. I'd wondered if there were any commercial products that I was not aware of.
    – developer__c
    Commented May 5, 2021 at 10:49
  • 1
    I also use SfApexDoc, but have recently used this that works well too but generates markdown files for Jekyll and Docsify sites.
    – Kris Goncalves
    Commented May 5, 2021 at 12:54
0

You can also checkout oAtlas, which is native to Salesforce. It builds out your org dictionary automatically and then you can document flows, apex classes, fields, etc...

Full disclosure, I am the developer of oAtlas.

Improve this answer

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .