Understanding Search in Spekit

SKIP AHEAD TO: Key Features of Search Ordering of Search Results Searchable Content Returning to Search Results Filters and Sort AI Synonyms Shared Content Empty Speks Understanding Search Relevance How to Search the Content Tab How to Access Recently Viewed Content How to Optimize a Spek's Searchability Improving Your Search Experience with Spekit & Algolia Integration

Learn how to use the search feature in Spekit. Search results may vary based on your access level. 

 

 

Key Features of Search 

Spekit's search feature helps users quickly find relevant content. The ranking and visibility of search results depend on various factors, ensuring accurate and efficient content retrieval.

 

Ordering of Search Results

Search results are primarily ranked based on:

1. Title (Label) Priority: Keywords appearing at the start of a Spek’s title rank higher.

2. Definition Relevance: Content within a Spek is searched, with priority given to matches in the first 40,000 characters.

3. Custom Fields: These are searchable but ranked lower than titles and content.

4. Multi-Term Matching: Results with all search terms appearing together rank higher than partial matches.

 

Searchable Content

Users can search for different types of content, including Speks, Files, Spotlights, Flows, Knowledge Checks, and Topics. However, Viewers cannot search for Spotlights. Content creators can also edit objects directly from search results.

 

 

Returning to Search Results

There's a slight adjustment to how you return to search results:

• In the Web App, use the back button to return to your previous search results.

• In the Chrome Extension, search results cannot be accessed via the back button. Instead, users must re-run the search by clicking the search icon.

 

Filters and Sort

Please note that filters and sorting are disabled on the search results page but remain available on the Library page and Content view.

 

AI Synonyms

Spekit leverages Algolia’s AI models to improve search results using synonyms. Approved synonyms apply across all organizations. Examples include:

• Intro ↔ Introduction

• Client ↔ Customer

• Holiday ↔ Vacation

 

Shared Content

A globe icon on content cards indicates if a Spek is externally shareable. Only Spekit Admins and Experts can share Speks externally, with SmartSend customers gaining access to activity analytics.

 

 

Empty Speks

Admins can see Empty Speks (previously known as undocumented Speks) in search results. 

 

A specific icon appears for hidden Speks, and a toggle allows filtering for empty Speks:

 

Understanding Search Relevance

For those interested in the technical aspects of search relevancy, here are some key points:

• Typos: Search accounts for minor misspellings.

• Word Proximity: Search terms appearing close together improve ranking.

• Singular vs. Plural: Searches recognize singular and plural forms of words.

• Ranking: Higher keyword matches increase a Spek’s position in results.

 

How to Search the Content Tab

1.) Navigate to the Web App.

2.) Select the Library tab.

3.) Choose Content and then List View.

4.) Use the Search in the data dictionary bar to find specific terms.

 

NOTE: The Data Dictionary Search Bar is specific to Speks, title, and body. While the Universal Search Bar includes all Spekit content, is powered by Algolia, and is available to all users.

 

How to Access Recently Viewed Content

1.) Navigate to the Web App.

2.) Click the Search Bar.

3.) View your 10 most recently viewed Speks and Files.

4.) Click any item to reopen it.

 

 

How to Optimize a Spek's Searchability

To create content in a way that optimizes searchability and helps users find them easily, you should consider the following strategies:

• Use clear and relevant names with important keywords at the start.
• Prioritize essential terms in the title and first part of the definition.
• Leverage tags wisely, placing them at the beginning of the Spek.
• Maintain consistent, well-structured content for higher rankings.
• Utilize AI synonyms to broaden accessibility.
• Encourage feedback to refine search relevance.
• Test different search queries to understand ranking behavior.
•  

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.

 

Improving Your Search Experience with Spekit & Algolia Integration

The Spekit-Algolia integration continuously enhances search accuracy by addressing:

• Typos and ranking inconsistencies

• Synonym recognition and refinement

• Improved content discoverability

Spekit's Learning Squad is actively working to refine search functionality. For feedback or inconsistencies, reach out to the Spekit team.