Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me

RoboHelp 2015 Provides Users with More Control

July 28, 2015 by RDesprez 2 Comments

Adobe Robo­Help (2015 release) allows users to change the con­tent that appears in a HTML5 help project.

For years, users did­n’t have a lot of con­trol over the type of con­tent that would appear in a user guide or online help project. The tech­ni­cal writer made those deci­sions. For exam­ple, if there were three pri­ma­ry audi­ences for a project, the writer would write the con­tent for three audi­ences, tag them with con­di­tion­al text, and then gen­er­ate three sep­a­rate user guides or help projects.

Robo­Help (2015 release), Adobe’s lat­est ver­sion of its help author­ing tool, gives users more con­trol over the type of con­tent they read. For exam­ple, let’s say I have two audi­ences for this online help project: sys­tem admin­is­tra­tors and end users. These read­ers can con­trol the type of con­tent that dis­plays in the help by click­ing the Fil­ter but­ton and select­ing the check box­es for the dif­fer­ent audi­ences. By select­ing System_Administrator, the help auto­mat­i­cal­ly dis­plays the con­tent for that audi­ence. Select­ing User will dynam­i­cal­ly change the con­tent for that audience.

System_Admin_Help

For some online help projects, this may pro­vide a lot of ben­e­fits to the writer and the audi­ence. For writ­ers, they won’t need to pro­duce 10 sep­a­rate deliv­er­ables. Instead, they could cre­ate one deliv­er­able and let the audi­ences fil­ter what they want to view. For cer­tain audi­ences, users may appre­ci­ate view­ing and fil­ter­ing all of the con­tent. Writ­ers could include fil­ters on coun­try (for exam­ple, US or Cana­da), audi­ence type (basic users and advanced users), audi­ence title (sup­port staff or project man­agers), and so on.

Although some advanced users may appre­ci­ate this fea­ture, I am not sure it is for every­one. Here are two reser­va­tions I have:

  • Will users even know this fea­ture is avail­able? Users will need to click the Fil­ters tab to see the fea­ture.  Tech­ni­cal writ­ers will prob­a­bly need to high­light and explain the fea­ture as it’s not com­mon on web sites.
  • Will users under­stand what to tog­gle? Tech­ni­cal writ­ers will cre­ate the fil­ters. Will users always under­stand the fil­ters that writ­ers cre­ate? There may be times when users pick the wrong fil­ters, lead­ing to mis­lead­ing and con­fus­ing infor­ma­tion. In addi­tion, when a user selects a fil­ter, there may be no vis­i­ble change in the con­tent for a cer­tain topic—resulting in poten­tial con­fu­sion over what the fea­ture is controlling.

When you’re writ­ing for a tech­ni­cal­ly savvy audi­ence or pow­er users, Robo­Help’s dynam­ic fil­ter­ing may pro­vide a great solu­tion. But novice users may not dis­cov­er the fea­ture or read­i­ly under­stand it.

How RoboHelp’s Search Could be Better

Apart from major user inter­face improve­ments, Robo­Help (2015 release) includes an incre­men­tal improve­ment to the way the search engine works. For more back­ground on this change, see this Tech­whirl review.

As I wrote in an ear­li­er blog entry, 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 (2015 release) , users are still unfor­tu­nate­ly left on their own when it comes to craft­ing a good 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 platforms.”

I don’t see why it can­not be deployed in a help author­ing tool.

Filed Under: Help Authoring Tools, Robert Desprez | Vancouver technical writer | Blog Tagged With: Help Authoring Tools, RoboHelp

FrameMaker comes full circle with version 12

May 9, 2015 by RDesprez 5 Comments

When I recent­ly start­ed using Adobe’s lat­est ver­sion of FrameMak­er, I felt déjà vu.

Back in the 2000, when I used FrameMak­er 6.0, I wrote con­tent in the soft­ware pro­gram and then con­vert­ed it to Web­Help using Quadralay Cor­po­ra­tion’s Web­Works, which was inte­grat­ed into FrameMak­er at the time. I tagged my con­tent in FrameMak­er using para­graph styles and Web­Works duti­ful­ly con­vert­ed those para­graph styles into HTML code. At the time I worked for a com­pa­ny that want­ed me to cre­ate a help project that took advan­tage of sin­gle sourc­ing. Some­how, I fool­ish­ly accept­ed the task of fig­ur­ing how to cre­ate Web­Help out of FrameMaker.

The project had its share of chal­lenges. The main one was that Web­works’ Java-based ver­sion of the help was not reli­ably appear­ing on users’ screens, osten­si­bly due to issues with the Java Run­time Envi­ron­ment. After con­sid­er­able hair pulling, I dis­cov­ered that Web­Works could out­put a JavaScript ver­sion of the help. Dis­as­ter averted!

In 2005, Adobe acquired Macro­me­dia and with it Robo­Help, its help author­ing tool. A few years lat­er,  Abobe offered its Tech­ni­cal Com­mu­ni­ca­tions Suite, which pro­vid­ed tighter inte­gra­tion between FrameMak­er and Robo­Help. For the first time, you could write con­tent in FrameMak­er and then have con­tent con­vert­ed to help by Robo­Help. Sort of like the FrameMak­er and Web­Works integration.

But not exact­ly. As Robo­Help has been around since 1991, much of its user inter­face looks like a movie from the 1990s. FrameMak­er is no spring chick­en either. Togeth­er, the user is faced with two respect­ed but old and bloat­ed soft­ware pro­grams that are forced to com­mu­ni­cate for the first time. The com­mu­ni­ca­tion worked but it was­n’t ide­al. For exam­ple, when I linked the help files in Robo­Help to the orig­i­nal FrameMak­er files, the updat­ing process was slow and some­times incon­sis­tent. If I made an edit to a FrameMak­er chap­ter, Robo­Help did­n’t always detect the change. And the updat­ing process was­n’t exact­ly sprightly.

Fast for­ward to Adobe’s lat­est ver­sion of FrameMak­er. Ver­sion 12 enables tech­ni­cal writ­ers to cre­ate online help right from FrameMak­er. By not forc­ing users to deal with Robo­Help in the help cre­ation process, I found cre­at­ing Web­Help to be much faster than ear­li­er ver­sions when users need­ed to tog­gle between FrameMak­er and RoboHelp.

FrameMak­er 12 can cre­ate HTML5 help for mobile devices, Web­Help, EPUB files, Kin­dle files, and Microsoft HTML Help.

I have used Robo­Help for years and cre­at­ing online help direct­ly from FrameMak­er does require some par­a­digm shifts (for exam­ple, how table of con­tents are cre­at­ed). But over­all, FrameMak­er 12 makes it faster and sim­pler to cre­ate online help. A wel­come change.

Filed Under: Career Development, Help Authoring Tools, Robert Desprez | Vancouver technical writer | Blog Tagged With: FrameMaker, online help, RoboHelp, WebWorks

FrameMaker 12 documentation disappoints

March 22, 2015 by RDesprez 1 Comment

As FrameMak­er is an author­ing tool made for tech­ni­cal writ­ers, you might think that its help would be exemplary—a show­case of the tool’s capa­bil­i­ties that would inspire oth­er writ­ers to per­form their best work.

Clear­ly, the Adobe tech­ni­cal com­mu­ni­ca­tion group does not share that vision. When I launched FrameMak­er’s help to search for clar­i­fi­ca­tion on its new fea­ture that enables authors to pub­lish to online help (with­out Robo­Help), I felt disappointed.

First, the image qual­i­ty of the screen cap­tures is so poor that I found myself squint­ing to deci­pher them. From the “Mul­ti­chan­nel pub­lish­ing” help top­ic, here are two exam­ples of pix­e­lat­ed graphics:

Publish_icon_croppedGenerate_Multiple_outputs_cropped

In addi­tion, I felt dis­ap­point­ed because the “Mul­ti­chan­nel pub­lish­ing” help top­ic is so long—it is 27 pages when copied to a Word file! A few suggestions:

  • Chunk the con­tent: With a sea of text and a hand­ful of pix­e­lat­ed graph­ics (some of which are mis­aligned), it is over­whelm­ing. I’d split the con­tent into sub-pro­ce­dures to make the con­tent eas­i­er to digest.
  • Reduce the text: Believe it or not, the “Mul­ti­chan­nel pub­lish­ing” help top­ic con­tains almost 7,000 words. When writ­ing con­tent that will be read online, aim to reduce the word count by 50 per­cent. That means if you write a doc­u­ment that is meant to be print­ed and it is 1,000 words, con­sid­er writ­ing 500 words for an online doc­u­ment. With­out a doubt, I’m sure that the con­tent could be more con­cise. For more infor­ma­tion about these guide­lines, see Ruth­less­ly edit when writ­ing for mobile.

I usu­al­ly don’t go out of my way to be crit­i­cal of oth­er tech­ni­cal doc­u­men­ta­tion. If you want to cre­ate online help that is not out­stand­ing, that’s your choice. But per­haps the Adobe writ­ers could at least strive for clear and concise?

Filed Under: Help Authoring Tools, Online Writing, Robert Desprez | Vancouver technical writer | Blog Tagged With: FrameMaker, Help Authoring Tools, online writing

Ways to keep your skills sharp

March 2, 2014 by RDesprez 3 Comments

There’s no short­age of con­fer­ences, train­ing web sites, and webi­na­rs to keep your skills sharp.

As I stat­ed in an ear­li­er blog entry, I believe it’s up to you to keep your­self mar­ketable and cre­ate your own train­ing plan. I like this quote from a recruiter: “You can’t rely on a com­pa­ny for your growth and train­ing anymore…Except for a few enlight­ened com­pa­nies, if they’re train­ing you at all, they’re train­ing you for what they need, not nec­es­sar­i­ly train­ing for what you need to devel­op your tech­ni­cal skills over the long run.”

My pro­fes­sion­al devel­op­ment plan includ­ing attend­ing a con­fer­ence every two to three years, aug­ment­ed with reg­u­lar self-direct­ed learn­ing. The last few years I’ve attend­ed and pre­sent­ed at two Writ­er­sUA con­fer­ences. Between con­fer­ences, I sign up for tech­ni­cal writ­ing webi­na­rs and read busi­ness and tech­nol­o­gy books. I also sub­scribe to Wired. Last year, I signed up for a mem­ber­ship to Lynda.com.

Lynda.com

Lynda.com teach­es com­put­er skills in video for­mat to mem­bers through month­ly and annu­al sub­scrip­tion-based plans. I’ve found it help­ful for learn­ing how to cre­ate EPUBs and brush­ing up on Robo­Help, FrameMak­er, Microsoft Office pro­grams, Cas­cad­ing Style Sheets (CSS), and Search Engine Opti­miza­tion for web sites.  One glar­ing exception—Lynda.com does not offer train­ing for Mad­Cap Flare.

Recorded webinars

I reg­u­lar­ly watch record­ed webinars.

Adobe offers free record­ed videos for tech­ni­cal writers:

http://tinyurl.com/y3j72x

Mad­Cap also offers free webinars:

http://tinyurl.com/lv8vrcq

Scrip­to­ri­um Pub­lish­ing offers time­ly and insight­ful thoughts on tech­ni­cal writ­ing trends:

http://tinyurl.com/kxa67qn

The Soci­ety for Tech­ni­cal Com­mu­ni­ca­tion also offers webi­na­rs for a fee:

http://tinyurl.com/mhvkg8a

Conferences

Here’s a sum­ma­ry of upcom­ing con­fer­ences this year.

Mad­World 2014 World­wide Learn­ing Con­fer­ence, April 13–15, San Diego
http://www.madcapsoftware.com/events/madworld/

Con­tent Man­age­ment Strategies/DITA North Amer­i­ca 2014, April 28–30, Seattle
http://www.cm-strategies.com/2014/index.htm

STC annu­al con­fer­ence, May 18–21, Phoenix
http://summit.stc.org/program-info/program-overview/

Lava­con, Octo­ber 13–15, 2014, Portland
http://lavacon.org/2014/about-portland/

How do you keep your skills current?

Filed Under: Career Development, Help Authoring Tools, Online Writing, Robert Desprez | Vancouver technical writer | Blog, Search Engine Optimization, Technology Tagged With: career development, conferences, learning web sites, technical writers, webinars

Controlling alignment and orphans in an EPUB file

May 24, 2013 by RDesprez 4 Comments

This blog entry explains some tips and tricks on how to con­trol align­ment and wid­ows and orphans in an EPUB file.

Some basics

An EPUB doc­u­ment is a zip file with the .epub exten­sion. EPUB files can be read using e‑reader soft­ware on many devices includ­ing the iPad, iPhone, PCs, and smart­phones run­ning on Android.

For tech­ni­cal writ­ers, I believe EPUB files are one of the tech­nolo­gies to watch. The iBooks book­store sells its e‑books in an EPUB file for­mat. With tablets and smart­phones out­selling PCs, users are increas­ing­ly read­ing content—including tech­ni­cal communications—on these devices. Help Author­ing Tools also make it easy to cre­ate EPUB files.

Controlling alignment

In your Help Author­ing Tool, you can spec­i­fy your text align­ment. Most of the time, tech­ni­cal writ­ers left-align their con­tent. But if you are view­ing your EPUB file on an iPad, it over­rides your align­ment set­tings and presents the con­tent as justified.

Here’s an exam­ple of jus­ti­fied align­ment on an iPad:

EPUB file shown on an iPad

For­tu­nate­ly, you can over­ride the iPad settings.

The eas­i­est way to do this is by ask­ing users to make a con­fig­u­ra­tion change on the iPad. As this is a pret­ty straight­for­ward change, I think it’s rea­son­able to ask users to fol­low a few steps.

To change the jus­ti­fi­ca­tion set­tings on your iPad:

  1. Go to Set­tings on your iPad.
  2. Go under your Apps set­tings and click iBooks.

Settings screen on an iPad

  1. Turn off Full Jus­ti­fi­ca­tion to over­ride the settings.
  2. Open an EPUB file in iBooks.

Your con­tent is then aligned the way you designed it.

Controlling widows and orphans

In some e‑readers, you can con­trol wid­ows and orphans. A wid­ow is the last line of a para­graph, marooned on one side of a page break. Here is an example:

Example of widow in an EPUB file

An orphan is a word, part of a word, or very short line that appears by itself at the end of a paragraph.

Using the Cas­cad­ing Style Sheet (CSS) in your EPUB project, you can con­trol wid­ows and orphans in Adobe Dig­i­tal Edi­tions and Nook. As of May 2013, you can­not con­trol wid­ows and orphans in iBooks.

Unzipping an EPUB

Com­plete the fol­low­ing steps to unzip your EPUB file: 

  1. Locate your EPUB file.
  2. Change the .epub exten­sion to .zip.
  3. Unzip the con­tents of the folder.
  4. Dou­ble-click the OEBPS fold­er (“OEBPS” stands for Open eBook Pub­li­ca­tion Structure).

Structure of EPUB

  1. Locate the default.css file. This is your CSS file.

Editing your CSS

Using a text edi­tor, type the fol­low­ing code that spec­i­fies the for­mat­ting for wid­ows and orphans.

widows_orphans_CSS

For the para­graph tag (“p”), the high­light­ed exam­ple ensures that at least two lines of con­tent appear togeth­er at the bot­tom or top of a page so that you don’t have sin­gle-line wid­ows and orphans. Of course, you can change the val­ue to what­ev­er you prefer.

Next steps

After you make changes to the CSS, re-zip the EPUB project, rename so it uses an .epub exten­sion, and test it on all the dif­fer­ent e‑readers that your users may be using. Dif­fer­ent e‑readers may ren­der your EPUB file dif­fer­ent­ly so test­ing is vital.

I am speak­ing about for­mat­ting EPUB files at the Cana­da West Chap­ter of the STC on July 16th, 2013.

Filed Under: Career Development, Help Authoring Tools, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology

  • « Previous Page
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • Next Page »

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,144 237

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 ·
2 May 1918126029463536113

This productivity poison is exhausting you /via @globeandmail

This productivity poison is exhausting you

Constantly shifting your attention undermines what is your super power in most knowledge jobs. How you anticipate an...

www.theglobeandmail.com

Reply on Twitter 1918126029463536113 Retweet on Twitter 1918126029463536113 0 Like on Twitter 1918126029463536113 0 Twitter 1918126029463536113
robert_desprez avatar; Robert Desprez @robert_desprez ·
24 Apr 1915491435350253736

Google forcing some remote workers to come back 3 days a week or lose their jobs

Image for twitter card

Google forcing some remote workers to come back 3 days a week or lose their jobs

Several units within Google have told remote staffers that their roles may be at risk if they don't start showin...

cnb.cx

Reply on Twitter 1915491435350253736 Retweet on Twitter 1915491435350253736 0 Like on Twitter 1915491435350253736 0 Twitter 1915491435350253736
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 Apr 1912364221582758283

Image for twitter card

As Canadians cancel trips due to Trump, the U.S. tourism industry could lose billions

The Trump administration's attacks on its northern neighbor have been met with confusion and anger by some Canadians...

www.npr.org

Reply on Twitter 1912364221582758283 Retweet on Twitter 1912364221582758283 0 Like on Twitter 1912364221582758283 0 Twitter 1912364221582758283
robert_desprez avatar; Robert Desprez @robert_desprez ·
13 Apr 1911507080504303659

Image for twitter card

How to awaken Canada’s sleeping economic giant

Recent interviews with industry leaders and experts point toward 10 areas where actionable strategies are needed – ...

www.theglobeandmail.com

Reply on Twitter 1911507080504303659 Retweet on Twitter 1911507080504303659 0 Like on Twitter 1911507080504303659 0 Twitter 1911507080504303659
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.