Packaging documentation

Packaging documentation
ksawery lisinski

Packaging documentation

Summary

In this course you will learn how to use Elements to build documentation sets that add Salesforce metadata documentation, process steps and in-app help.

Documentation packaging allows the documentation on Salesforce metadata to be packaged from one Org and then applied to another Org with version control and release management. This could be used by an ISV to provide technical, support and help documentation for their managed packages, by SIs to package up their IP, or for customers to copy documentation between multiple Orgs.

Learning objectives

By the end of this course, you will be able to:

  1. Understand versioning logic associated with documentation packages
  2. Create documentation packages
  3. Install documentation packages in Orgs

Prerequisites

This course relies on you understanding how to document Salesforce Org metadata using Elements. We recommend that you first complete the course below before you continue.

On top of that there are some technical requirements. You will need:

  1. Corporate management enabled for your organization with the packaging module (ask us to enable this for you)
  2. Corporate admin permission
  3. Space admin permission
  4. Synced Org Model
  5. Edit rights on the Org model