Skip to main content

How do I navigate Spekit’s Web App?

  • Updated

SKIP AHEAD TO:

Top Navigation bar 

Navigating the Wiki view 

Navigating the Dictionary view

Navigating a Spek in the Web App

Navigating the Analytics view

Navigating the Settings page

Learn how to use the Spekit Web App and all the features available. Ensure you are logged in before continuing. Some information may require Account Admin, Team Admin, or Expert-level access.  

 

Top Navigation Bar

Screenshot 2024-07-24 at 9.08.59 PM.png

Open the Spekit Web App. You will see the following navigation items on the top:

  1. Home
  2. Wiki
  3. Analytics
  4. Settings
  5. Search
  6. New Button | Ask an Expert
  7. Notification Bell

 

1. Home

  • The Web App Home is the browser-enabled centralized Spekit information hub.
  • On the Home page, you can see assigned Knowledge Checks, view popular content, get analytics on your content, and much more. 

 

2. Wiki

 

3. Analytics

  • Available for Account Admins, Team Admins, & Experts

  • The Analytics tab will allow you to check in on your team quickly.
  • You can view analytics by User, Activation, Spek Views, and Searches from the Analytics tab. You can also export the data to CSVs. 
  • Click here to learn more about the Analytics tab. 

 

4. Settings

  • Available for Account Admins & Team Admins

  • The Settings tab is dedicated to managing your Spekit organization. 
  • In the Settings tab, you can manage Teams & Users, view Admin Tools, access your Spekit plan, and Connect Spekit with some of our Integration partners.  

 

5. Search

  • This is the search bar that appears in the extension, as well as in the top right corner of every page in the Web App.
  • This search bar returns any Spekit content (i.e., Speks, Topics Spotlights, Flows, and Knowledge Checks) relevant to the search term.
  • The universal search bar is powered by Algolia and primarily orders results by label and then by definition. It also takes into consideration word proximity, typos, and synonyms.
  • All Spekit users have access to the universal search bar.

 

6. New Button 

 

6. Ask an Expert  

  • Available for Viewers

  • This feature allows Viewers to reach out to their organization’s Experts to ask questions or request specific content. 
  • If the Spek has an associated Expert, the comment will go directly to them. If the Spek does not have an associated Expert, the comment will be directed to an email address set up by your CSM. 
    NOTE: To update this email, send a request to support@spekit.co.

 

7. Notification Bell (Bell Icon) 

  • This is where you can view all your Spekit Notifications. These Notifications could be new Speks, reactions to your Speks, or updates to content.
  • You can view the Notifications you’ve received or check out the Notifications you sent to your team. 

 

Navigating the Wiki View

Click Wiki at the top of the Spekit Web App. 

Screenshot 2024-07-09 at 12.21.41 PM.png

You will see the following navigation items on the left sidebar:

  1. Topics
  2. Content
  3. Flows
  4. Spotlights
  5. Knowledge Checks
  6. Library
  7. Profile
  8. Help Center

 

1. Topics 

  • Topics are where you can see all of the Topics and Team Spaces you have access to. By default, the Topics tab will automatically be selected when a User clicks on Wiki.  Learn more about Topics here.
  • In the Topics tab, you can sort Topics by
    • Topic Name (A - Z)
    • Topic Name (Z - A)
    • Last edited date (Newest)
    • Last edited date (Oldest)
    • Create date (Newest)
    • Create date (Oldest)

 

2. Content 

  • Content is where you can see all of the content you have access to. By default, the Content tab will automatically have the Grid view selected. Learn more about Speks here.
    • Grid view presents the content the same way Topics do, in blocks with a preview of the Spek. 
    • Dictionary view presents the content in a table, where you can quickly sort and select multiple Speks. 
  • In the Content tab, you can view hidden content, Filter, and Sort content. Click here to learn more about Filtering.

 

3. Flows  

  • Flows is where you can see all of the Flows you have access to. You can edit different Flows or check out what Flows already exist. Click here to learn more about Flows.
  • In the Flows tab, you can sort Flows by
    • Flow Label A - Z
    • Flow Label Z - A
    • Flow Status A - Z
    • Flow Status Z - A
    • Last Published Date (Newest)
    • Last Published Date (Oldest)
    • Last Published By A - Z
    • Last Published By  Z - A
  • Note: Not all accounts have Flows enabled. If you are an Admin and would like to enable Flows for your company, please contact your success manager or support@spekit.co

 

4. Spotlights 

  • Available for Account Admins, Team Admins, & Experts

  • Spotlights are where you can see all of the Spotlights you have access to. You can access all Spotlights, published or drafts, preview, edit, Filter, and/or sort them. 
  • In the Spotlights tab, you can Filter by Content and Targeting. 
  • In the Spotlights tab, you can sort by
    • Spotlight Label A - Z
    • Spotlight Label Z - A
    • Status A - Z
    • Status Z - A
    • Last Published Date (Newest)
    • Last Published Date (Oldest)
    • Last Published By A - Z
    • Last Published By  Z - A
  • Click here to learn more about Spotlights.

 

5. Knowledge Checks

  • Available for Account Admins, Team Admins, & Experts

  • From the Knowledge Checks tab, you can filter through our Knowledge Checks. You will also be able to click into any Knowledge Check to edit, publish, or send a reminder. Click here to learn more about Knowledge Checks. 

 

6. Library 

  • Available for Account Admins & Team Admins

  • The Library contains free content that your organization can import into your Spekit account. This content has been created so your team doesn’t have to start from scratch when building your Spekit. Click here to learn more about Spekit's Library. 

 

7. Profile  Screen_Shot_2022-10-17_at_5.26.50_PM.png

  • When you click Profile, you can either go to your profile page or sign out.
  • From this button, you can edit your profile. 

 

8. Help Center  Screen_Shot_2022-10-17_at_5.26.54_PM.png

  • By clicking Help Center, a new tab will open on your browser, bringing you to Spekit’s Help Center. 

 

Navigating the Dictionary view

Screenshot 2024-07-24 at 9.15.52 PM.png

To access the Dictionary view. 

1.) Click Wiki at the top of the Spekit Web App. 

2.) From the Wiki tab, click Content. 

3.) Click Dictionary. 

 

There are several options available to you in the Dictionary view:

 

Search 

  • This search bar only appears when you are in the Wiki section of the Web App, Select Speks, and view the results in Dictionary mode. 
  • It will only return Speks that match the search term (i.e., it will not return Topics, Spotlights, Flows, or Knowledge Checks in the results).
  • The data dictionary returns search results based on exact text match in the title and body and does not take into consideration word proximity, typos, or synonyms.
  • Only Admins and Experts have access to the data dictionary search bar.

 

Tabs  

  • These are all the Data Types available to you in your Dictionary. You can view all the data types by clicking on View All or selecting a specific one, such as Objects. 

 

View Hidden Content  

  • If you turn on View Hidden Content, the toggle instantly displays all terms, including those terms that were previously hidden. The following screen will appear if you turn on this feature.

 

Select All  

  • This will select all Speks available to you. From here, a drop-box will appear, Bulk Actions, and you can edit every Spek at once. 
  • Available Bulk Actions: 
    • Hide Terms
    • Unhide Terms
    • Assign Expert
    • Print to PDF
    • Add Topics
    • Remove Topics
    • Delete Speks

 

Filter 

Screenshot 2024-07-24 at 9.18.04 PM.png

You can Filter through Speks. Click here to learn more about available Spekit Filters.

 

Sort  

From the Speks tab, you can sort by

  • Last Edit Date (Newest)
  • Last Edit Date (Oldest)
  • Spekit Title (A - Z)
  • Spekit Title (Z - A)
  • Create Date (Newest)
  • Create Date (Oldest)
  • Last modified in Salesforce (Newest)
  • Last modified in Salesforce (Oldest)

 

Toggle Columns  

  • The Toggle Columns feature allows you to select which columns you want to display in your Dictionary. 
  • To Toggle Columns:
    • Click the icon below to Toggle Columns. 
    • Select the columns you want to display from the drop-down menu by clicking on the checkbox. 
  • The Toggle Columns feature includes all the custom metadata columns created. This is helpful when you want to display all the information related to your documentation, such as API integrations or Jira tickets, in a tabular format. Click here to learn how to create custom columns in Spekit. 

unnamed.gif

 

Navigating a Spek in the Web App

In the Web App, you can interact with Speks by hovering over them or clicking on them. Each way provides you with different editing options and information. 

 

Hovering Over Speks  Screen_Shot_2022-10-21_at_1.15.49_PM.png

When you hover over a Spek, the Spek will gray out and give some interaction options.

 

  • Select Spek  Screen_Shot_2022-10-21_at_1.16.22_PM.png

    • There will be a purple circle located at the top left of the Spek. This circle is the Select option. If you click on this circle, a Bulk Actions drop-down will appear with the following options.

 

  • Edit Spek  Screen_Shot_2022-10-21_at_1.16.30_PM.png

    • The edit icon will allow you to skip opening the Spek and go directly to the editing screen for that Spek.

 

  • View Spek  Screen_Shot_2022-10-21_at_1.09.42_PM.png

    • By clicking the View Spek button, you can view the content with the Spek. 

 

  • Share Spek  Screen_Shot_2022-10-21_at_1.16.49_PM.png

    • By clicking the Share icon at the bottom of the Spek, you can share the Spek with other Spekit Users or externally via a direct link. 

 

NOTE: Only Account Admins and Team Admins are allowed to share external URLs to Speks by copying the URL of the Spek from Share externally via a direct link.

 

  • Hide & Unhide Speks  Screen_Shot_2022-10-21_at_1.16.53_PM.png

    • The eye icon allows you to hide and unhide a Spek. When a Spek is hidden, no one can view the content within the Spek.

 

Clicking Into Speks

When you click View Spek, a pop-up window will appear on the screen with the Spek. You can interact with Spek in several ways from this screen.

 

  • Favorite Speks  Screenshot 2023-12-01 at 8.23.56 AM.png

    • Starring a Spek saves the Spek to the starred items, making them available whenever you open My Favorites in the Chrome Extension. 
    • NOTE: While accessing the list of favorites is still limited to the Spekit Chrome Extension, this update significantly improves the user experience and convenience of the Spekit platform

 

  • Last Updated Screenshot 2023-12-01 at 8.19.20 AM.png

    • Under the Spek Title, you will see who edited the Spek last and on what date. 

 

  • Mark as Read  Screen_Shot_2022-10-21_at_1.33.03_PM.png

    • At the bottom of the Spek content, you will see a purple Mark as Read button. You can track which Speks you have and haven’t read by clicking this button. 

 

  • Topics  13.png

    • At the bottom of the Spek, you will see which Topics the Spek resides in. Speks can live within multiple Topics so that you may see more than one Topic here. 

 

  • Emoji Reactions  14.png

    • On the base of the Spek, you will see a bar with emoji reactions. By selecting an emoji, you can provide the Spek Expert with feedback about how valuable the content was. There are six available reactions:
    • 😍 = Incredible
    • 💯 = On Point
    • 🎉 = Celebrate 
    • 👍 = Helpful
    • 🤨= Confused
    • 👎 = Not Helpful

 

  • Edit  Screen_Shot_2022-10-21_at_1.42.08_PM.png

    • Available for Account Admins, Team Admins, & Experts
    • The edit button will bring you directly to the editing screen for that Spek. 

 

  • Share Screen_Shot_2022-10-21_at_1.42.15_PM.png

    • By clicking the Share icon at the bottom of the Spek, you can share the Spek with other Spekit Users or externally via a direct link.

Note: Only Account Admins and Team Admins are allowed to share external URLs to Speks by copying the URL of the Spek from Share externally via a direct link.

 

 

  • Hide  Screen_Shot_2022-10-21_at_1.42.20_PM.png

    • The eye icon allows you to hide and unhide a Spek. When a Spek is hidden, no one can view the content within the Spek. 

 

  • Clone  Screen_Shot_2022-10-21_at_1.42.25_PM.png

    • You can easily clone a Spek by clicking the clone icon. 
    • When cloning a Spek, a new pop-up will appear with the cloned Spek. You can tell that it is a cloned Spek because the Spek title will start with [CLONED].

 

 

  • Analytics  Screen_Shot_2022-10-21_at_1.42.43_PM.png

    • Analytics are available on the Spek level if at least one person has viewed and/or interacted with the Spek. Views and Reactions per Viewer break down Spek analytics. 
    • View Analytics
      • Viewed By
      • Last Viewed
      • Total Views
      • Mark as Read
    • Reaction Analytics
      • Reacted By
      • Date
      • Reaction Type
    • Click here to learn more about Spek Analytics. 

 

  • Expert  Screen_Shot_2022-10-21_at_1.42.55_PM.png

    • The name of the Spek Expert is displayed on the right side of the content. The Spek Expert and the person who last edited the Spek may not be the same, but if the content is out-of-date, it is best to reach out to the Spek Expert. 

 

  • Related Objects  Screen_Shot_2022-10-21_at_1.43.04_PM.png

    • Related Objects refer to the Salesforce field the Spek is connected to. There are a couple of Related Objects options.
      • Account
      • Campaign
      • Case
      • Contact
      • Lead
      • Opportunity 
      • Partnership

 

  • Arrows  Screen_Shot_2022-10-21_at_1.43.29_PM.png  Screen_Shot_2022-10-21_at_1.43.34_PM.png

    • Located on either side of the Spek, these arrows will allow you to click through Speks within a Topic or Search results. 

 

Navigating Analytics in Spekit 

Screenshot_2022-11-03_at_3.53.06_PM.png

 

Click Analytics at the top of the Spekit Web App.  You will see the following navigation items on the left sidebar:

  • By User
  • Activation
  • Spek Views
  • Searches

Click here to learn more about the Analytics tab. 

 

Navigating Settings in Spekit 

Screenshot 2024-10-10 at 3.44.15 PM.png

 

Under the Setting tab, you will find the following:

 

Teams and Users

You can manage Teams, Users, and Invitations on the Teams and User tab. 

  • TeamsScreen_Shot_2022-10-20_at_3.19.01_PM.png

    • From the Teams section, you can create new Teams or manage existing ones. You can edit the Team name, Users’ Team roles, the Team description, and which Topics are accessible to the Team.

  • Users  Screen_Shot_2022-10-20_at_3.19.06_PM.png

    • From the Users section, you can view all Users invites to Spekit: pending, activated, or deactivated. While managing Users, you can Search, Filter, and sort Users based on their Spekit and/or Salesforce properties. 
    • Additionally, you can easily click into a User to view a User’s profile information, Teams, and Roles. In this view, you can edit the User’s roles, add or remove them to Teams, impersonate the Users view, and/or deactivate the User. 

 

 

 

View our User management documentation here to learn more about Teams and Users. 

 

Admin Tools

In the Admin Tools tab, you can create Metadata Columns and Bulk upload content into Spekit. 

  • Metadata ColumnsScreen_Shot_2022-10-20_at_3.32.26_PM.png

    • In the Metadata Columns section, you can create Metadata columns. Metadata columns allow you to add company-specific information around any existing Spek. For example, you could add a mapped internal API name. 
    • Click here to learn how to create custom columns in Spekit. 

  • Bulk UploadScreen_Shot_2022-10-20_at_3.32.35_PM.png

    • You can quickly upload content into Spekit using the proper importing format in the Bulk Upload section. Click here to learn how to import and export content from Spekit. 

 

Plan

In the Plan tab, you can view your organization's current Spekit plan and the billing details. Billing details include the billing amount, frequency, last charge date, and next charge date. This tab will also show the number of available licenses your organization has and how many are active. 

unnamed.png

 

Connect

You can connect Spekit with a couple of different Integrations and Extensions in the Connect tab.  Our one-click integrations automatically pull in Metadata and import new fields and Metadata. 

Screenshot 2024-10-10 at 3.58.45 PM.png

 

API Tokens

You can now manage your API tokens directly within the Spekit Web App. Set custom expiration periods ranging from 1 week to "Never Expire" and easily track each token with a description field to keep your usage organized. Click here to view our API docs. 

Screenshot 2024-10-10 at 3.48.18 PM.png

 

Related Articles: 

Related articles