How to Create and Manage Speks

1. Where Can I Create a Spek?

You can create Speks from three different places:

1.) The Web App

2.) The Chrome Extension

3.) Slack

Option 1: The Spekit Web App

You can create Speks in two different ways from the Spekit Web App:

A.) Create a Spek using the +New button

B.) Create a Spek from the Topic View

Create a Spek using the +New button

1. Open the Spekit Web App.
2. Click on the +New button in the top navigation bar.
3. A pop-up will appear on the screen, select Create a Spek.

Create a Spek from the Topic View

1. Open the Spekit Web App.
2. Click on Hub and select Topics
   
3. Navigate to the Topic you would like to add content to.
4. Click the +New button.
   
5. A pop-up will appear on the screen, select Spek.
   

Option 2: The Spekit Chrome Extension

You can create Speks in two different ways from the Chrome Extension:

A.) Create a Spek from the Spekit Chrome Extension

B.) Create a Spek using our Salesforce integration for an existing field, picklist, or Object

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 (Also known as Sidekick).
2. Click on +New in the top navigation bar.
   
3. A pop-up will appear on the screen, select 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 and type shift + command + S on your keyboard to find it.
   
3. To find your empty field or picklist Speks, search for the name and filter by Speks. You can even filter by "Only show undocumented Speks" as well.
   
4. Toggle on Only show empty Speks.
5. Now, you will see empty Speks that need definitions.
6. Open any Spek you'd like and click Edit to add content to that Spek.
   

Option 3: Slack

Prerequisites: Install the Slack Integration. Read more about our Slack Integration here.

1. Use the overflow menu to create a Spek from an existing message.
   1. Click on the three dots
      

   2. Select the Connect to Apps option

      

   3. Click on Create a Spek
      

2. How to Embed a Spek Icon on a Website?

Create a Spek to embed in an application in Chrome

You can embed Speks directly in most web applications using Chrome. Here's how to set it up:

1. Create a Spek using the Web App or the Chrome Extension.
2. Enter the Label of the Spek, which needs to be an EXACT text match to where you'd like the Spek to appear. Capitalization and punctuation need to be exact.
   

3. 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!
4. Add the Spek being created to one or more Topics. This Topic must have the Domain URL linked to the website you're targeting, otherwise the embedded Speks will not show up. To make sure your custom Speks show up where they should, click here to learn how.
5. Click the Save button to publish your newly created Spek.
6. Open the Spekit Chrome Extension (Sidekick).
7. Click on the ellipsis [...].
8. Select Settings, and enable the Display Spek Icons toggle.
   

3. How to Manage Content

Once your Speks are created, use these tools to organize, reorder, and manage them within a Topic.

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 the Reorder Content button.
   
4. From here, you can move content around to the order you would like it 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.

Actions You Can Take on Content

Beyond rearranging, you can take several actions directly within a Topic or Content view to keep your library organized:

• Edit or Hide individual Speks and Files.
• Delete content individually, from the Chrome Extension, or in bulk using Bulk Actions.
• Clone existing Speks to quickly create similar content.

For step-by-step instructions on deleting content—individually, from the Chrome Extension, or in bulk—see our Spek FAQs.

4. Where Can I Find Version History, and How Do I Use It?

Version History in Spekit allows admins and experts to track and review changes made to Speks and files. Follow these steps to access it:

1. Open the Spekit Web App.
2. Open up a Spek you would like to view the Version History of.
3. Click the Version History icon.
   
4. A sidebar will appear, displaying all versions of the Spek in reverse chronological order (newest to oldest).
   What you'll see in Version History:
   • Change Details: The name of the user who made the edits and a timestamp.
   • Change Scope: Versions are created for updates to titles, content (description), or uploaded files. Metadata changes (e.g., permissions or custom fields) do not create new versions or impact the last edited date shown to users.
   • Highlighting Changes: Additions are highlighted in green, while deletions are highlighted in red.