Learn how to create Speks in the Web App, Chrome Extension, embedded on applications, Salesforce, and Slack.
Where can I create a Spek?
You can create Speks from three different places:
1.) The Web App
3.) Slack
Option 1: The Spekit Web App
1.) Open the Spekit Web App.
2.) Click on the New button in the top right corner.
3.) Select Spek.
NOTE: When creating Speks in the Web App, there is a 10-minute delay in the Spek showing up. If you click the Spekit logo in the top left of the extension, the page will refresh and the Spek will appear.
Option 2: The Spekit Chrome Extension
You can create Speks from three different types of Speks from the Chrome Extension:
A.) Create a Spek from the Spekit Chrome Extension
B.) Create a Spek to embed in an application in Chrome
C.) Create a Spek using our Salesforce integration for an existing field, picklist, or Object
D.) Add a Spek to a button on an object page layout
E.) Add a Spek to a Dashboard or custom page in Salesforce
Create a Spek from the Spekit Chrome Extension
Simply open your extension by clicking on the Dock to pop open the sidebar or click on the Spekit icon in your extension toolbar.
1.) Open the Spekit Chrome Extension.
2.) Click on the New button in the top right corner.
3.) Select Spek.
Create a Spek to embed in an application in Chrome
You can embed Speks on most applications in Chrome. To create embedded Speks, please follow these instructions:
1.) Open the Spekit Chrome Extension.
2.) Click Settings, and enable Show Help Text Icons.
3.) Click on the New button in the top right corner.
4.) Select Spek.
5.) Enter the Label of the Spek which needs to be an EXACT help text icon of where you’d like the Spek to appear. Capitalization and punctuation need to be exact.
- For example, if we want to embed a Spek next to the “360 view” text, we would create a custom Spek with the label “360 View”
NOTE: The Spek will show up wherever that text is found on the domain. For instance, if 360 View is listed more than once in Outreach, the same Spek will show in the various locations.
6.) Enter a Definition for the Spek. You can add style to the text using the rich text options. Click here to learn how to use our rich text editor!
7.) Add the Spek being created to one or more Topics. This Topic must have the Domain URL linked, or the embedded Speks will not show up.
To ensure the custom Speks show up on the page, please follow these instructions:
1.) Open the Spekit Web App.
2.) Navigate to the Topic that will host all of the custom Speks.
3.) Click Edit Topic.
4.) Fill in the Domain URL with the URL you would like the custom Speks to appear on. You can add more than one domain.
5.) Click Save Topic.
8.) Click the blue Create Spek button, and refresh the page.
Note: If you are using our Salesforce Integration, make sure to read more instructions below on how to document your existing fields synced in Spek.
Create a Spek using our Salesforce integration for an existing field, picklist, or Object.
Our unique Salesforce integration allows you to import fields and picklists from any object into Spekit. Ensure you have imported the object and synced it to Salesforce since that field was added to make sure it shows up in Spekit. Learn more about our Salesforce integration here.
To add a Spek next to your existing field:
1.) Open the Spekit Chrome Extension.
2.) Search for that field in the sidebar OR highlight the field label type S on your keyboard to find it.
3.) To find your empty field or picklist Speks, search for the name and filter by Speks.
4.) Toggle on Only show empty Speks.
5.) Now, you will see empty Speks that need definitions.
6.) Click on the Spek.
7.) Click Add Content.
Add a Spek to a button on an object page layout
You can create a Spek on a button on an object page layout on most applications in Chrome, please follow these instructions:
1.) Open the Spekit Chrome Extension.
2.) Click Settings, and enable Show Help Text Icons.
3.) Click on the Create button in the top right corner.
4.) Select Spek.
5.) Enter the Label of the Spek which needs to be an EXACT help text of the button.
- For example, if we want to embed a Spek next to the Opportunities label, we would create a custom Spek with the label Opportunities.
Note: The Spek will show up wherever that text is found on the domain. For instance, if Opportunities is listed more than once in Salesforce, the same Spek will show in the various locations.
6.) Enter a Definition for the Spek. You can add style to the text using the rich text options. Click here to learn how to use our rich text editor!
7.) Add the Spek being created to the Topic linked to the domain the button is on.
8.) Link to the Salesforce Object.
9.) Click the blue Create Spek button, and refresh the page.
Add a Spek to a Dashboard or custom page in Salesforce
You can create a Spek on a Dashboard or Visualforce in Salesforce by following these instructions:
1.) Open the Spekit Chrome Extension.
2.) Click Settings, and enable Show Help Text Icons.
3.) Click on the Create button in the top right corner.
4.) Select Spek.
5.) Enter the Label of the Spek which needs to be an EXACT help text icon of the dashboard text. Capitalization and punctuation need to be exact.
- For example, if we want to embed a Spek on the title of an Events Dashboard, we would create a custom Spek with the label Events Dashboard.
NOTE: The Spek will show up wherever that text is found on the domain. For instance, if Events Dashboard is listed more than once in Salesforce, the same Spek will show in the various locations.
6.) Enter a Definition for the Spek. You can add style to the text using the rich text options. Click here to learn how to use our rich text editor!
7.) Add the Spek being created to the Salesforce Topic linked to the Dashboards page.
8.) Click the blue Create Spek button, and refresh the page.
Option 3: Slack
Prerequisites: Install the Slack Integration. Read more about our Slack Integration here.
1.) Enter /spekit create to open up a window to create a Spek
2.) Use the overflow menu to Create a Spek from an existing message.
Use Case: Once you've answered a question - use the overflow menu to Create a Spek from that message. It'll auto-populate the definition for you so you can re-use the answer in the future.
How to Delete Content
HOW TO DELETE CONTENT
1.) Open the content you would like to delete.
2.) Click the ... ellipses.
3.) Click Delete.
4.) A pop-up will appear to confirm that you would like to delete the content.
HOW TO BULK DELETE CONTENT
1.) Open the Topic where the content you would like to delete is located.
2.) Select the content you would like to delete by clicking the checkbox in the upper lefthand corner of the Spek.
3.) Click Bulk Actions.
4.) Click Delete Speks.
5.) A pop-up will appear to confirm that you would like to delete the Spek.
How to Optimize Speks for Search
To create Speks in a way that optimizes searchability and helps users find them easily, you should consider the following strategies:
-
Clear and Relevant Names: Ensure that the names you assign to your Speks accurately represent their content. Use concise and descriptive names that reflect the core topic or subject matter of the Spek.
-
Prioritize Important Keywords: Since search results are ordered primarily by name and then by definition, make sure to incorporate essential keywords in both the name and the initial part of the definition. This increases the chances of your Speks appearing in relevant searches.
-
Use Tags Wisely: If you use "Tags" within the body of your Spek, consider placing them at the beginning of the Spek or in the title. This is important because the definition is truncated to the first 40,000 characters, and placing tags at the start ensures they're more likely to be seen.
-
Consistent and Relevant Content: Create Speks with accurate and consistent content. This helps improve their relevance to search queries. The more closely a Spek matches the user's search terms, the higher it will rank in the search results.
-
Leverage Synonyms: With the AI synonyms feature enabled, take advantage of synonyms to expand the reach of your Speks. Consider incorporating synonyms of key terms to ensure your content is accessible even when users use different terminology.
-
Include Important Details Early: Place crucial information and key details near the beginning of your Spek's definition. Since the definition is truncated, having important content upfront increases the chances of it being seen in search results.
-
Utilize Spotlights: Use Spotlights to highlight critical information or key concepts within your Speks. This can help users quickly identify relevant Speks and understand their content at a glance.
-
Encourage Feedback: Encourage users to provide feedback if they encounter issues while searching. This could include instances where they don't get the expected results or experience abnormalities. This feedback can be invaluable for refining the search functionality.
-
Test Different Search Queries: Experiment with various search queries to understand how your Speks are being ranked and displayed. This can give you insights into how users might be searching for your content and help you fine-tune your labeling and content creation.
-
Stay Informed: Keep yourself updated on any changes or improvements in the search functionality. This way, you can adapt your Spek creation strategies to align with the evolving search algorithms.
By implementing these strategies, you can enhance the searchability of your Speks and provide a more efficient and effective experience for users looking for specific content within Spekit.
How to rearrange Content in a Topic
1.) Open the Spekit Web App.
2.) Open the Topic you would like to reorder content in.
3.) Click Reorder Content button.
4.) From here, you can move content around to the order you would like to appear in the Topic.
5.) Once you are done reordering the content, click Save Changes.
The content will now be rearranged in the Topic.