Follow these steps to start driving digital adoption with Spekit today!
Welcome to Spekit! Here’s a step-by-step guide to help you get started
This guide will cover the following:
- Connecting Spekit to your Salesforce instance
- Importing Salesforce Objects into Spekit
- Inviting your team members to Spekit
- Hiding terms in Spekit
- Assigning an Expert to terms in Spekit
- Creating Custom Metadata Columns in Spekit
- Creating Documentation
Haven’t downloaded the Spekit Chrome Extension yet?
Click here to download the Spekit Chrome Extension before moving forward
Step 1: Connecting Spekit to Salesforce
The Salesforce integration will sync all your Objects and Fields into Spekit with a single click.
To connect your Spekit to your Salesforce:
Check permissions and restrictions in Salesforce
Check your Salesforce profile for the required permissions to connect to Spekit.
Client applications that access Salesforce through the API must first log in as a Salesforce user for authentication. Create a special user in your organization, solely for integration purposes.
That way, if an actual user leaves your organization, you'll always have a user with the correct permissions available.
The Salesforce user profile has No IP Restrictions
Does your company use SSO (such as OKTA)?
You must be logged into Salesforce via your SSO provider BEFORE you attempt to login to Spekit
- From the Connect tab in the Spekit web app
1 ) Click Settings
2 ) Click Connect
3 ) Click the blue Connect to Salesforce button
Verify you have the necessary Salesforce permissions needed to connect
1 ) Check the checkbox to confirm: I have the required Salesforce permissions
2 ) Click Connect a Salesforce Production or Developer org to connect your Spekit account to Salesforce
Log in to Salesforce
You’ll be redirected to Salesforce to login
Enter your Salesforce user id and password and click Login
You’ll be prompted with an OAuth to allow Spekit to communicate with Salesforce
- You will be routed back to the app.spekit.co WebApp
Please allow the sync to run on the page and do not navigate within the Spekit WebApp tab or open it in a new tab because this can interrupt the sync process
Step 2: Importing Salesforce objects
Upon completion of the initial sync, you are taken to the Manage Objects page
You must select at least one Salesforce object to import (Example: Opportunity or Account)
Click Import selected objects
Please allow the sync process to complete and do not navigate within the Spekit WebApp
b. Select the Objects you want to import
We recommend importing one or two of the most important and critical objects. You can always import more objects later
This will avoid an overcrowded dictionary and will make the most out of your documentation efforts
c. Click Import selected objects
Wait up to 10 minutes for the import to complete. Larger Salesforce orgs will take longer
When the sync process completes you are taken to the All Speks view which is a mix of field Speks and Custom Speks
Step 3: Inviting your team
With Spekit, you don’t have to tackle content creation alone! You can invite (a) Salesforce users as well as (b) non-Salesforce users on your team to help with documentation efforts. As you invite Teammates, consider the following role assignments available in Spekit:
- The Viewer: They have read-only access.
- Expert: They have limited edit and configuration access.
- Admin: They will own the Spekti Platform for their org. They have full edit and configuration access.
a. To invite a Salesforce user:
Go to the Invite Salesforce Users page
From the Spekit WebApp
1 ) Click Invite
2 ) Click Invite Salesforce Users
- Perform a search for the user you want to invite
3 ) Click the blue Invite button at the end of the row of the name of the person
- A modal will appear in the middle of the screen
4 ) Click the top drop-down to select the Spekit team
5 ) Click the second drop-down to select the Spekit team role (Viewer, Expert, Team Admin, Account Admin)
6 ) Click the blue Add 1 User button
- You will receive an onscreen notification in the bottom left corner that tells you Invite Successful
b. Invite non-Salesforce users:
1 ) Click Invite
2 ) Click Invite with email
3 )Enter First name
4 )Enter Last name
5 )Enter Email
6 )Enter Username
- When creating a Spekit Username, please be sure to use all lowercase letters and no symbols
- If you receive a message the Spekit Username you selected is already in use, please add an additional alphanumeric character
7 ) Click the blue-button to Choose team and role
1 ) Click the top drop-down to select the Spekit team
2 ) Click the second drop-down to select the Spekit team role (Viewer, Expert, Team Admin, Account Admin)
- Click the blue Add 1 User button
Step 4: Hiding terms in Spekit
- Spekit will sync all fields associated with the Object you imported that exist in your Salesforce instance
- There may be a ton of fields that you don’ use anymore or that don’t need to be documented at all Spekit allows you to hide, rather than delete the fields that are unimportant to avoid filling your Dictionary with junk or unwanted terms
a. To hide an individual Spek:
Click on the eye icon in the expanded view of the Spek
b. To hide multiple Speks:
- Select the terms you want to hide
- Click Hide Speks
- If you want to bulk unhide Speks
- Click the toggle View hidden Speks
- Select the terms you want to unhide
- Click Unhide Speks
You can view these hidden terms using the Filter options
You can further unhide these terms at any point
Click here for more information on how to HIde and Unhide terms in Spekit.
Step 5: Assigning Experts
You can use the assign an Expert option to crowd-source the expertise of your colleagues or delegate documentation to a subject matter expert on your team.
You can assign an expert to an Object allowing them to document all the fields associated with the particular Object OR You can assign an expert to each individual field and term in Spekit
- To assign an expert to multiple terms at once:
- Select the terms you want to assign the Expert for
- Click Bulk actions
- Click Assign Expert
You can further assign an expert directly from the dashboard
Visit your dashboard to see terms that haven’t been assigned to anyone and terms that are assigned to you as well
Step 6: Creating Custom Columns
With Custom Columns, you can add custom, company-specific information to existing fields, objects or other metadata in your Dictionary
To create Custom Columns:
- Go to the Admin Tools page in the Spekit WebApp
- Click Create Metadata Column
Here you can view all your custom columns and their details
You can further delete these columns from this page if needed
Once you’ve created a Custom Column, you can view it in the Metadata section in the expanded view of the Spek that it applies to
You can further select which columns you want to display in the Dictionary view using the Toggle Column feature
This is helpful when you want to display all the information related to your documentation in a tabular format
Step 7: Creating Content
Now that you’re set up… It’s time to create documentation!
With Spekit you can add and create as much documentation as you like by simply creating a Spek
A Spek is a bite-sized piece of custom knowledge
It can be used to document any process, step-by-step walkthrough or term in your company for easy access
Here is what a Spek looks like:
The Spek will display all associated Metadata and stats related to the term
Always create a content plan for your documentation before actually creating the content and filling out the Speks
This will allow you to make the most out of your documentation efforts.
You’re all set to go!… Happy Speking!