How to embed content in Salesforce with Spekit

To embed content within Salesforce, you first need to connect your Spekit account to Salesforce. For more information on how to do this, click here. You can embed a Spek next to any object, field, picklist value, or custom component.

To do so, simply select what you would like to document by typing ‘S’ or right clicking to select Spekit. Doing so will open the sidebar, and you’ll see empty Speks. Select which component you would like to document, and click the “Add Content” button to add documentation. If you’d like to organize the Spek, we recommend adding a topic or expert. 

‍

Objects - The object Spek is a great way to give high-level guidance on the purpose of the object and what it’s used for, as well as links to any other key processes.

‍

Picklist Values - To add a Spek to a picklist value, you’ll need to import your picklist values first. Documenting your different statuses can be particularly helpful for ensuring your teams understand the different statuses of your content.

‍

Fields - Creating Speks in your fields can be particularly helpful for documenting anything that your users need to understand about your fields from a data hygiene standpoint.

‍

Custom Speks - Custom Speks will work on any buttons or components. To create a custom Spek, open the Spekit extension, click “New” followed by “Spek,” and enter the exact keywords. Make sure to add a topic and link the Spek to its relevant object. Once you've published the Spek, refresh the page and the Spek should show up next to the custom component. To add a Spek to a custom dashboard component, you'll need to create a Spek and add it to a specific topic.

‍

Tip: If you’re not seeing a newly added Spek, simply refresh the page for the spek to appear.