Generating Documentation for your Salesforce Instance

The documentation of the Salesforce instance has always been a tiring job; it takes a lot of time, the time which could be used to do something productive and also the job being a time consuming one is very monotonous. No one likes the documentation job but it is the important part, it has to be done.

Imagine you are the admin of your Salesforce instance and your boss asks for the detail of the object or the trigger that are being used in the app. So now you have to prepare the documentation for the app or imagine some of the developers are reporting that there is a problem with the app and they are not able to see some of the data, so being the admin first you have to check the hierarchy setting of the app and see whether they are allowed to see the data or not, or you have to now change the hierarchy setting but for this single job just for checking the hierarchy of the app you have to go through all the coding of the app but instead of doing such a long and tedious task it can done by click of the single button.

Astrea It services have come up with the solution for this painful and mundane job. Astrea has developed an app which can do the documentation job for you for just a few click of the buttons.

“Octopus” yes the name matches the work that it does, it grabs all the data from the Salesforce instance and then display it in a single document, and it can also be said that it allows you to document all the items in your Salesforce instance. Get information about apex classes, pages, workflows, triggers, objects, fields and much more in a single place and the best part is that the document can also downloaded as a PDF/Word file for future reference.

You can get the product from Salesforce Appexchange

The key features of the Octopus being:

  1. It gets information on various items with a single click.

  2. It provides the user the ability to choose the items to be documented.

  3. It has a default ‘Select all’ feature so that all the items can be checked.

  4. It enables Navigation to the detail page of an item by clicking on its name.

  5. The report can be downloaded as PDF or MS Word files.

The items supported by Octopus are:

    • Apex Classes
    • Apex Components
    • Approval Processes
    • Async Apex Job Information
    • Custom Fields on Standard Objects
    • Custom Objects and Fields
    • Dashboard Information
    • Email Template Information
    • Mail Merge Templates
    • Object Permission
    • Organization
    • Profiles
    • Queues
    • Record Types
    • Reports
    • Static Resources
    • Triggers
    • User Roles
    • Users
    • Validation Rules
    • Visualforce Pages
    • Workflow Rules
    • Workflow Field Updates

So instead of spending long hours in the documentation work or going through the code for a single information required let the octopus handle the problem. It just requires a few clicks of the buttons to do the documentation and in the matter of seconds documentation will be ready.