Hey Scott,
There are a few things we do on our end at my company. Our Database is backed up, and is the most critical thing.
I don't know of any process to automagically generate documentation, if that is what you are asking? We did some theory concept on using JAVADOC type format in the DOCU tab, etc, but it just ended up being too complicated.
Here is how we document flows:
Every automation flow (Job plan) has its own word document.
These documents are from a template that includes:
- Standard naming convention: COMPANY - AUTOMIC - SYSTEM - WORKFLOW SHORT DESCRIPTION NAME Example: Foo- Automic- MyBillingApp- Invoice process.docx
- Header including (Last update date, reason, person)
- Table of contents (linked via internal doc links)
- Overview- Short summary 1-2 paragraphs max of the flow
- Access requirements - (Includes details about servers/logins/etc, NO PASSWORDS)
- Definitions and Acronyms
- Manual Start/Stop procedures(Only filled out for jobs that need to be stopped during outages)
- Scheduling - Details about when this runs, name of object that kicks it off, any holidayinformation.
- Process - Screenshot of high level jobplan (workflow), including step numbers on each item in the flow. Small table fileld out for each step (name, purpose, restartable?, potential errors, etc)
- Detailed overview of automation(anything that needs to be spelled out)
- Disaster recovery- (Exact Manual Steps needed if Automic broke, and we needed to get all availble resources manually transfering files and running scripts)