Document your code and configuration elements

Creating proper and meaningful code documentation is one of the basic ways of making your code readable, easy to understand and maintain. 

We suggest to follow at least these suggestions for documenting your code and configuration elements: 

  • For all the Configuration Elements (CEs) with a description field, make sure you use it to describe what the change is about.
  • For all the CEs which include code, make sure to include a documentation header in the code.
  • For all the CEs that group changes (such as Update sets in ServiceNow and ChangeSets in Salesforce), make sure you include a description field which explains the details of the change and allows for its tracking to a specific release. 
Confused? Check our Glossary

Last modified on Nov 24, 2020