Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me
You are here: Home / Help Authoring Tools / How RoboHelp’s search could be better

How RoboHelp’s search could be better

November 26, 2012 by RDesprez 5 Comments

Tweet

Almost every­one on the Inter­net uses search. A study by Pew Inter­net last year found that 92 per­cent of adults who are online use search engines to find infor­ma­tion on the Web.

I can­not imag­ine life with­out search. When I have a prob­lem with some­thing I own, such as a DVD play­er, I might look up the prob­lem in the print­ed user guide (if I still have it!), go to the manufacturer’s web site, or just type the name and mod­el of the DVD play­er in Google’s search field. From my expe­ri­ence, Google often pro­vides results that are as use­ful as the manufacturer’s sup­port web site.

Users still search for help even on the iPad, which is fre­quent­ly her­ald­ed as “so intu­itive.”  On the iPhone, I fre­quent­ly use its search fea­ture as I try to find an elu­sive email.

Two weeks ago, I attend­ed an Adobe webi­nar called “Using new Robo­Help 10 fea­tures to make con­tent more search­able.” This blog post gives my impres­sions of RoboHelp’s search engine.

External content search is a welcome addition

Adobe intro­duced exter­nal con­tent search in Robo­Help. This fea­ture enables you to define the key­words that users might type in the Search field and then direct them to an exter­nal web site. For exam­ple, you can set up your help so that when a user types “sup­port web site” in the Search field, the search engine dis­plays an exter­nal URL that you specify.

In the fol­low­ing screen cap­ture, in the Search Terms field, I’ve spec­i­fied the terms “sup­port, ACME sup­port, tech­ni­cal sup­port.” In the help, if a user types one or more of these terms, Robo­Help dis­plays the ACME sup­port web site.

Anoth­er nice fea­ture is that you can define these terms and then export them to oth­er Robo­Help projects, if needed.

How RoboHelp’s search could be better

RoboHelp’s search could be bet­ter by dis­play­ing key­words in the Search engine field.

When you type spe­cif­ic key­words in Google’s search field, the web site dis­plays a list of sug­gest­ed terms as you type the query. This solu­tion helps users because they may type terms incor­rect­ly or may not even be sure how to phrase their queries in a search field. Google dis­plays sug­gest­ed terms and dis­plays rel­e­vant web sites before I even fin­ish typing.

In Robo­Help, users are unfor­tu­nate­ly left on their own when it comes to craft­ing a good search.

Faceted search

Anoth­er wel­come addi­tion would be faceted search. Com­pa­nies, such as Dell, have used this tech­nique for some time. On Dell’s web site you can search for a lap­top or desk­top com­put­er. Alter­na­tive­ly, you can use the fil­ters to help you search by prod­uct cat­e­go­ry, proces­sor, screen size, weight, and so on.

For users, this helps stream­line their choic­es. In an online help sys­tem, users could use faceted search to dis­play con­tent by top­ic type (con­cepts, pro­ce­dures, trou­bleshoot­ing con­tent, files with attach­ments or embed­ded movies, and so on).

“Faceted nav­i­ga­tion is arguable the most sig­nif­i­cant search inno­va­tion in the past decade,” write Peter Morville and Jef­fery Cal­len­der in their book Search Pat­terns.“…Faceted nav­i­ga­tion is being rapid­ly deployed across an impres­sive­ly wide vari­ety of con­texts and plat­forms.” I don’t see why it can­not be deployed in a Help Author­ing Tool either.

[pullquote]“Faceted nav­i­ga­tion is arguable the most sig­nif­i­cant search inno­va­tion in the past decade…Faceted nav­i­ga­tion is being rapid­ly deployed across an impres­sive­ly wide vari­ety of con­texts and platforms.”[/pullquote]

SEO functionality for RoboHelp

If you end up post­ing your online help project to a pub­lic serv­er so it can be indexed by Google, Robo­Help’s search may not add much value.

Giv­en that more peo­ple may be using Google’s search to find your con­tent instead of RoboHelp’s own search engine, I think Adobe should con­sid­er some sort of Search Engine Opti­miza­tion func­tion­al­i­ty. For exam­ple, it would be nice to see a fea­ture that enables you to adjust key­words, meta­da­ta, and link­ing in your help project so that your con­tent is opti­mized for Google’s search. See my relat­ed blog entry about prepar­ing your online help for pub­lic use.

Do you agree? Could RoboHelp’s search be bet­ter? If so, how?

 

Filed Under: Help Authoring Tools, Robert Desprez | Vancouver technical writer | Blog Tagged With: Online Search, RoboHelp 10, Search Engine in RoboHelp, Ways to Improve Search in RoboHelp

Comments

  1. Rick Stone says

    December 1, 2012 at 9:42 pm

    Read­ing your arti­cle is fun­ny on a humor­ous note. Not that I’m pok­ing fun at what you wrote, just that Robo­Help DOES offer a func­tion­al­i­ty that *WILL* work like you are ask­ing with terms list­ed in the bot­tom pan­el and the out­put try­ing to match up these terms as you type.

    That func­tion is called an Index. And it’s a fab­u­lous addi­tion when prop­er­ly added. I’ve always described Search to be like this. With any sys­tem, the key ele­ment that makes it help­ful is an easy abil­i­ty to quick­ly locate what you are look­ing for. Using Search to find it is sim­i­lar to drop­ping a nuclear bomb into a city to try and kill one bad guy. But using an Index is much clean­er. It’s sim­i­lar to using a small laser guid­ed mis­sile to take out just the build­ing he is in.

    With an index, you map key­words to top­ics. When pre­sent­ed, if the user is look­ing for a top­ic they begin typ­ing. As they type, the list of Index key­words is adjust­ed to try and match what is being typed.

    As you have seen, Search works by first allow­ing the user to type the term (and pray they typed it cor­rect­ly) then all the con­tent is scanned and can­di­date top­ics are returned. The user then has to scan the titles and deter­mine whether any of them are wor­thy of inves­ti­gat­ing further.

    Google has actu­al­ly done users a dis­ser­vice when it comes to help sys­tems. Because Google type search­es are what they are accus­tomed to using, they most often head straight for search and will ignore an index if present. But the index is vast­ly better.

    Reply
  2. Robert Desprez says

    December 5, 2012 at 4:02 am

    Hi Rick,

    Here are my expe­ri­ences when it comes to indexing: 

    a) Demand for the index is wan­ing, in my opin­ion. Maybe it is the per­ceived suc­cess of Google’s search but I rarely hear any­one even ask­ing for an index any­more. In the 1990s, it was com­mon and the standard. 

    b) Even if there is a request for an index, they are usu­al­ly not done well. Sim­ple things like com­ing up with syn­onyms are often ignored. 

    c) Design­ing index­es are time con­sum­ing where­as search algo­rithms can index one’s con­tent in sec­onds. A prop­er­ly craft­ed index can take days, which is hard to jus­ti­fy in our eco­nom­ic cli­mate. It’s not sur­pris­ing that clients seem to pre­fer the inex­pen­sive, built-in option that comes with search. 

    In my opin­ion, search is the stan­dard, even with its weaknesses. 

    Thanks for your comment. 

    Robert

    Reply
  3. Karla Marsh says

    December 6, 2012 at 8:17 pm

    Even though no one asks for an Index, adding index key­words to top­ics, as Rick sug­gests, makes the top­ic more like­ly to appear in search results.

    Reply
  4. Colum McAndrew says

    December 6, 2012 at 8:25 pm

    These are all valid improve­ments for Robo­Help Robert. Have you request­ed them as fea­ture requests? It would be well worth doing if you want a chance of them being includ­ed in the next version.

    BTW I have writ­ten a post on my blog that out­lines how you can get bet­ter search results from your Robo­Help out­put. You can find it at: http://www.cmcandrew.com/robocolumn/archives/3496

    Reply
  5. Robert Desprez says

    December 7, 2012 at 5:26 am

    Hi Colum,

    Good idea! I’ll fol­low-up with Adobe on improv­ing Robo­Help’s search. Your arti­cle on improv­ing Robo­Help’s search looks great. Thanks for shar­ing it.

    Reply

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

About Robert Desprez

I have worked as a Vancouver technical writer for more than 20 years, working at some of British Columbia's largest high-tech firms. I have served in leadership positions for the Society for Technical Communication and have worked as a writing instructor at Vancouver's Simon Fraser University.

Robert Desprez Follow 1,150 239

Vancouver Technical Writer. Former Instructor at Simon Fraser University. Dog Lover. Coffee Drinker. Tennis and Piano Player.

robert_desprez
robert_desprez avatar; Robert Desprez @robert_desprez ·
7 Jun 1931387924311912959

Companies must make changes for training to be effective for younger workers /via @globeandmail

Image for twitter card

Companies must make changes for training to be effective for younger workers

Bottom line: for training to be effective today, especially for younger employees, it needs to be customized, relevant and timely

www.theglobeandmail.com

Reply on Twitter 1931387924311912959 Retweet on Twitter 1931387924311912959 0 Like on Twitter 1931387924311912959 0 Twitter 1931387924311912959
robert_desprez avatar; Robert Desprez @robert_desprez ·
26 May 1927021047175430324

How to throw a little luck into your career /via @globeandmail

Image for twitter card

How to throw a little luck into your career

What if you could create some of your own luck?

www.theglobeandmail.com

Reply on Twitter 1927021047175430324 Retweet on Twitter 1927021047175430324 0 Like on Twitter 1927021047175430324 0 Twitter 1927021047175430324
robert_desprez avatar; Robert Desprez @robert_desprez ·
20 May 1924848939888738806

Is AI helping workers and improving productivity or just creating more work? /via @globeandmail

Image for twitter card

Is AI helping workers and improving productivity or just creating more work?

To reap the full benefits of AI, companies must be more creative than using it to automate existing tasks, one expert says

www.theglobeandmail.com

Reply on Twitter 1924848939888738806 Retweet on Twitter 1924848939888738806 0 Like on Twitter 1924848939888738806 0 Twitter 1924848939888738806
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413647243559161

Image for twitter card

I Regret My Tesla | The Walrus

I wanted to be good. Then the car company fell from grace

thewalrus.ca

Reply on Twitter 1923413647243559161 Retweet on Twitter 1923413647243559161 0 Like on Twitter 1923413647243559161 0 Twitter 1923413647243559161
Load More

Recent Blog Posts

  • ChatGPT: The AI-Powered Proofreader
  • Four Ways Confluence Could Be Better
  • First impressions of MadCap’s purchase of IXIASOFT
  • Online Conferences for Technical Writers in 2023

About Me

Robert Desprez I have worked as a Vancouver technical writer for more than 20 years, working at Kodak, Boeing, Teck Resources, and FortisBC. In addition, I have worked as a writing instructor at Simon Fraser University in Vancouver.

Contact Me

Robert Desprez Com­mu­ni­ca­tions Inc.
North Van­cou­ver, British Columbia
Canada
Phone: 604–836-4290

  • Email
  • LinkedIn
  • Twitter

Copyright © 2025  · Robert Desprez Communications Inc.