Introduction to Mendable
In the modern digital landscape, documentation is the backbone of user experience, developer productivity, and customer support. However, as your content library grows, finding the exact piece of information you need can become a frustrating treasure hunt. This is where Mendable steps in. Mendable is an AI-powered search and chat tool specifically designed to help you interact with your own documentation through natural language. Instead of manually scanning through pages of text or relying on basic keyword searches that often miss the mark, Mendable allows you to ask questions in plain English and receive accurate, context-aware answers directly from your content.
Whether you are a developer looking to integrate a smart search bar into your product’s help center, a technical writer maintaining a large knowledge base, or a support team member trying to answer customer queries faster, Mendable simplifies the entire process. It connects to your existing documentation sources, indexes the content, and provides a customizable chat interface that understands what your users are really asking. This tutorial will walk you through everything you need to know about Mendable, from initial setup to advanced usage tips, ensuring you can leverage this tool to its full potential.
Getting Started with Mendable
Before you can start using Mendable to answer questions from your documentation, you need to set up an account and connect your content. The process is designed to be straightforward, even for non-technical users, but having a basic understanding of your documentation structure will help you get the best results.
Creating an Account
Navigate to the Mendable website at https://www.mendable.com/. Click on the “Get Started” or “Sign Up” button, which is typically located in the top right corner of the homepage. You can sign up using your email address or through a Google account. After confirming your email, you will be redirected to the Mendable dashboard, which is your central hub for managing all your documentation projects, which Mendable calls “sources”.
Connecting Your Documentation Source
Once inside the dashboard, the first step is to tell Mendable where your documentation lives. Mendable supports several types of content sources:
- Website URLs: You can provide a sitemap URL (e.g., https://yourdocs.com/sitemap.xml) or a list of specific page URLs. Mendable will crawl these pages and index the text content.
- GitHub Repositories: If your documentation is stored as Markdown or text files in a GitHub repository, you can connect Mendable directly to the repository. This is ideal for open-source projects or teams that use version control for their docs.
- Direct Upload: You can upload files directly, such as PDFs, Word documents, or plain text files. This is useful for internal documentation that is not publicly hosted.
- API Integration: For advanced users, Mendable offers an API to programmatically push content or sync from custom databases.
To get started, click on “Add Source” and select the type that matches your documentation. For example, if you have a help center hosted at help.yourcompany.com, choose “Website URL”, paste your sitemap URL, and click “Connect”. Mendable will begin crawling and indexing your pages. Depending on the size of your documentation, this process can take from a few minutes to a few hours. You can monitor the progress on the dashboard.
Configuring Your Chat Interface
After your content is indexed, the next step is to customize the chat interface. Mendable provides a default chat widget that you can embed on your website, but you can also adjust its appearance to match your brand. In the dashboard, navigate to the “Chatbot” or “Widget” settings section. Here you can:
- Change the primary color of the chat button and message bubbles.
- Set a custom welcome message (e.g., “How can I help you with our documentation?”).
- Define the position of the chat widget on the page (bottom right, bottom left, etc.).
- Add a custom avatar or logo.
Once you are satisfied with the appearance, Mendable will generate an embed code snippet (a small piece of JavaScript). You can copy this code and paste it into the <head> or <body> section of your website’s HTML. If you are using a content management system like WordPress, you can typically add this code using a plugin that allows custom HTML or JavaScript insertion, such as “Insert Headers and Footers” or by editing your theme’s code directly.
Key Features of Mendable
Mendable is not just a simple search engine; it is a comprehensive AI assistant tailored for documentation. Understanding its key features will help you use it more effectively and identify the best use cases for your organization.
AI-Powered Search for Documentation
Traditional search engines rely on keyword matching, which often fails when users phrase their queries differently than the document authors did. Mendable uses advanced natural language processing (NLP) to understand the intent behind a question. For example, if your documentation says “To reset your password, click on the profile icon,” and a user asks “How do I change my password?”, Mendable will still find the correct answer. It understands synonyms, sentence structure, and context, making it far more accurate than a standard site search.
Natural Language Question Answering
This feature is the core of Mendable. Instead of returning a list of links, Mendable attempts to provide a direct answer to the user’s question, pulled from your documentation. It will show the answer text along with a citation or link to the original source document. This saves users from having to click through multiple pages. For example, a user might ask, “What are the system requirements for version 2.0?” and Mendable will reply with the specific requirements listed in your docs, including a link to the relevant page for further reading.
Integration with Existing Documentation Sites
Mendable is designed to work with your existing infrastructure. It does not require you to migrate your content to a new platform. Whether your documentation is on a custom domain, a subdomain of your main site, or hosted on a platform like ReadMe, GitBook, or Confluence, Mendable can crawl and index it. The tool also supports dynamic content, meaning if you update a page on your site, Mendable will automatically re-index it (depending on your sync settings) to ensure the answers remain current.
Customizable Chat Interface
As mentioned in the setup section, the chat interface is highly customizable. Beyond colors and logos, you can also control the behavior of the chat. For instance, you can enable or disable the ability for users to provide feedback on answers (thumbs up/down), which helps you identify gaps in your documentation. You can also set up conversation starters, which are suggested questions that appear when a user first opens the chat, guiding them on what to ask.
Real-Time Answers from Your Content
Mendable processes queries in real time. When a user types a question, the AI searches your indexed content, analyzes the most relevant sections, and formulates an answer within seconds. This speed is crucial for user satisfaction, especially in customer support scenarios where delays can lead to frustration. The real-time nature also means that if you update your documentation and trigger a re-index, the new information will be available to users almost immediately.
How to Use Mendable Effectively
Using Mendable goes beyond simply installing the chat widget. To get the most value, you need to understand how to interact with it, how to interpret its responses, and how to maintain your documentation for optimal performance.
Asking Questions in the Chat
The chat interface is designed to be intuitive. Users simply type their question in natural language. There is no need to use special commands or syntax. For best results, encourage your users to ask full questions rather than fragmented keywords. For example, instead of typing “reset password”, they should type “How do I reset my password?” or “Can you show me the steps to reset my password?”. The AI is trained to handle variations, but complete sentences often yield more precise answers.
If the initial answer is not satisfactory, users can ask follow-up questions. Mendable maintains context within a single conversation session. For example, if a user first asks “How do I install the software?” and then asks “What about on Mac?”, Mendable will understand that the second question is a continuation of the first and will provide instructions specific to macOS.
Reviewing and Improving Answers
As an administrator, you have access to a dashboard where you can see the questions users are asking and the answers Mendable is providing. This is a goldmine of information. You can review these logs to:
- Identify gaps: If users frequently ask a question that Mendable cannot answer well, it indicates that your documentation is missing that information. You can then create a new page or update an existing one to cover the topic.
- Improve existing content: If Mendable provides an answer that is technically correct but poorly worded, you can improve the clarity of the source documentation. Mendable is only as good as the content it indexes.
- Provide feedback: In the dashboard, you can manually rate answers as good or bad. This feedback helps Mendable’s AI learn and improve its response quality over time for your specific dataset.
Using Mendable for Different Roles
Mendable is versatile and can be used by different teams within an organization:
- Customer Support: Embed the chat widget on your help center or support portal. Support agents can also use a private version of Mendable to quickly find answers while chatting with customers, reducing response times.
- Product Teams: Use Mendable to search through internal product specifications, API documentation, and design documents. It can replace the need to dig through shared drives or wiki pages.
- Engineering Teams: Developers can integrate Mendable into their development tools (e.g., via an API) to query documentation directly from their code editor or command line, speeding up the development process.
- Content Writers: Before writing new documentation, writers can use Mendable to check what already exists, avoiding duplication and ensuring consistency.
Tips for Getting the Most Out of Mendable
To ensure that Mendable provides the best possible experience for your users, follow these practical tips. They cover content preparation, configuration, and ongoing maintenance.
Structure Your Documentation Clearly
Mendable works best when your documentation is well-organized. Use clear headings (H1, H2, H3) and short paragraphs. Avoid large blocks of unstructured text. The AI uses the structure of your pages to understand the hierarchy of information. For example, a page titled “Installation Guide” with sections like “Windows Instructions” and “Mac Instructions” will help Mendable deliver more specific answers. Also, ensure your pages have unique and descriptive titles, as Mendable uses them to generate citations.
Keep Your Content Up to Date
Stale documentation is the enemy of accurate AI answers. Make it a habit to review and update your documentation regularly. When you make changes to your product or process, update the corresponding documentation immediately. In Mendable, you can configure automatic re-indexing schedules (e.g., every 24 hours) or trigger a manual re-index after a major update. Outdated content can lead to Mendable providing incorrect answers, which erodes user trust.
Use the Feedback Loop
Do not ignore the feedback feature. Encourage your users to use the thumbs up or thumbs down buttons on answers. In your dashboard, prioritize reviewing answers that received negative feedback. This direct user input tells you exactly where your documentation is failing. You can then either improve the source content or, in some cases, add specific instructions to Mendable on how to handle certain types of queries (if the tool offers custom rules).
Test with Real User Questions
Before rolling out Mendable to your entire user base, spend some time testing it with real-world questions. Gather a list of common support tickets or frequently asked questions from your team. Type these questions into the chat and see how Mendable responds. If the answers are off-target, you may need to refine your documentation or check if the pages are being indexed correctly. Testing helps you catch issues before your users do.
Monitor Performance Metrics
Mendable likely provides analytics on your dashboard, such as the number of questions asked, the percentage of questions answered successfully, and the average response time. Pay attention to these metrics. A low success rate (e.g., many unanswered questions) indicates a problem with your content coverage. A high success rate but low usage might suggest that users are not finding the chat widget easily. Use these numbers to guide your optimization efforts.
Consider Multi-Language Support
If your documentation is available in multiple languages, Mendable can handle this, but you need to set it up correctly. Ensure that each language version of your documentation is on a separate URL path (e.g., /en/ and /fr/). When connecting your source, you may need to add each language path separately or use a sitemap that includes all language versions. Mendable will then detect the language of the user’s question and attempt to answer from the corresponding language documentation.
By following this tutorial, you now have a comprehensive understanding of what Mendable is, how to set it up, and how to use it effectively. The key to success is treating Mendable not as a one-time installation, but as an ongoing partner in your documentation strategy. Keep your content clean, listen to user feedback, and continuously refine your setup. The result will be a powerful, AI-driven search experience that saves time and improves satisfaction for everyone who interacts with your documentation.
