From d96aac96b832c8aeaabb08eac72d348e0a0b2267 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Vannicatte?=
- Reducing users’ efforts to get started on your product or to
- resolve problems is the trick to smooth the learning curve.
- DocSearch brings relevancy to the fingers of your users.
+ Docs are only helpful when your users can find answers easily.
+ Enter DocSearch.
- First built to fulfill our own developers' needs,
- DocSearch quickly evolved as a successful community
- project. Over the years, the project kept on addressing
- the complex challenge of search for the open source
+ Initially created to fulfill our own developers' needs,
+ DocSearch quickly evolved into a successful community
+ project. Over the years, we've explored new ways to
+ address the complexities of search for the open-source
community.
- DocSearch understands your data, the user input, the
- context and sends back instantly a fine selection of
- your content available with less interactions than any
- other method.
+ DocSearch understands how the user input fits into the
+ context of your project and instantly presents the most
+ relevant content with fewer interactions than any other
+ method.
With a design very close to the native experience on
@@ -249,8 +248,9 @@ function Home() {
How it works
- We scrape your documentation, configure the Algolia
- application and send you the snippet you'll have to integrate.
+ We scrape your documentation or technical blog, configure the
+ Algolia application and send you the snippet you'll have to
+ integrate. It's that simple.
- Respect users efforts
+ Made for open-source
- Speak to all users
+ Customizable and fast
- Eliminate confusion
+ Mobile design
- You don’t need to configure any settings or even have an - Algolia account. We take care of this automatically. + You don't need to configure any settings or even have an + Algolia account. We take care of this for you!
@@ -318,7 +318,8 @@ function Home() {We'll send you a small snippet to integrate DocSearch to - your website! + your website and an invite to your fully configured + Algolia application.
@@ -334,12 +335,12 @@ function Home() {- Search is a conversation so we used a modal dialog to ask for - information that, when provided, significantly lessen users’ - effort to navigate through the results. + Search doesn't have to be painful — when a user searches + through your docs, they'll get a frictionless modal dialog to + work in.
- When displaying the results it's important to get a - sense of the documentation structure. DocSearch split - your content in small chunks and the UI is returning - this information to the user + DocSearch organizes the search results into chunks + that reflect how your documentation is structured.
- It looks almost similar to a search input but it’s a + It looks almost similar to a search input but it's a button. When you click/touch or use the keyboard shortcut, it opens a modal dropdown and focuses the search input. @@ -541,11 +540,12 @@ function Home() {
- Most of our search queries take take less than 20ms to - be processed. + Most of our search queries take less than 20ms, so + Algolia can run a new search on every keystroke and + instantly highlight relevant content to your users.
- Deliver relevant results, with robust out-of-the-box - typo tolerance. + Use our analytics to keep an eye on your search + performance and to make sure that your users are + finding what they're searching for.
- Undertstand how your search performs and ensure that - your users are able to find what they’re searching - for. + Algolia knows what your users mean to search for right + out-of-the-box, so they won't be spending time + correcting typos.
Once users become familiar with a system they will become better