Salesforce documentation template and checklist

Use it with or without aprity

Download the Markdown file and open it in your editor or adapt it to your documentation tool. Use one section per clearly scoped component or process. The template contains no customer data.

Start with the date, environment and scope, then replace the bracketed fields. Leave unavailable information as unknown; do not substitute zero or none.

What to collect

• Identity: object or component, API name, version, activation state and owner.
• Behaviour: trigger, conditions, reads, writes, branches and exceptions.
• Evidence: file path, source component, revision and the passage supporting each statement.
• Dependencies: related components and external systems, with the search boundary.
• Validation: expected outcomes, actually observed outcomes and execution date.
• Decisions: confirmed business intent, open questions and next review.

Review checklist

A person who did not write the document should be able to locate every source. An expected outcome is not an executed test result. Screenshots need context and must not hide important conditions.

Before sharing, remove secrets, personal identifiers and unnecessary business data. Keep sensitive evidence in a workspace with appropriate access controls.