Robert Desprez Communications

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

Three Challenges of Writing for Mobile

November 30, 2017 by RDesprez Leave a Comment

Now that Android is the lead­ing oper­at­ing sys­tem used to con­nect to the Inter­net, tech­ni­cal writ­ers need to seri­ous­ly look at how their con­tent is being dis­played on smart­phones and tablets.

For years, smart­phone and tablet use has sky­rock­et­ed.  In 2016, the num­ber of smart­phone users was expect­ed to sur­pass 2 bil­lion (source: eMar­keter). Sim­i­lar­ly, there are about 1.5 bil­lion peo­ple who are expect­ed to use a tablet by 2019 (source: eMar­keter). Ear­li­er this year, Android has edged out Win­dows as the num­ber one oper­at­ing sys­tem used to access the Inter­net.

Mean­while, tech­ni­cal writ­ers appear to be slow to embrace mobile. In one study com­plet­ed last year of more than 700 tech­ni­cal com­mu­ni­ca­tion pro­fes­sion­als, only 24 per­cent of tech­ni­cal writ­ers pub­lish con­tent that would be con­sid­ered “mobile ready.”

Although there may be an unde­ni­able user demand for every­thing mobile, prepar­ing con­tent has its share of challenges.

Challenge Number One: Small Screen

In spite of the mod­ern trend towards larg­er-screen phones, what makes mobile phones so con­ve­nient and portable is their small size. Com­pared with desk­top and even lap­top screens, phone screens accom­mo­date a lot less content—see the fol­low­ing illus­tra­tion com­par­ing the sizes of mon­i­tors, tablets, and smartphones.

As a result, mobile users must work hard­er to access the same infor­ma­tion and rely on their short-term mem­o­ry to refer to infor­ma­tion that is not vis­i­ble on the screen.

One way to mit­i­gate users’ small screens is to embrace brevi­ty. One usabil­i­ty con­sul­tant rec­om­mend­ed that if you write 100 words for a print-based doc­u­ment, con­sid­er writ­ing 50 words for the web. For mobile, aim to reduce the word count even more.

Challenge Number Two: Comprehension

Jakob Nielsen, a usabil­i­ty con­sul­tant, has per­formed some stud­ies on user com­pre­hen­sion lev­els on mobile devices.

In a recent study, he found that, on aver­age, com­pre­hen­sion scores were slight­ly high­er when users read the arti­cles on mobile devices. How­ev­er, dif­fi­cult con­tent may cause low­er com­pre­hen­sion on mobile.

The dif­fi­cul­ty of the arti­cles (“easy” or “hard”) was deter­mined by the num­ber of words and the dif­fi­cul­ty of the lan­guage used (accord­ing to the Flesch-Kin­caid read­ing-lev­el for­mu­la). All of the arti­cles were pre­sent­ed as HTML pages cre­at­ed from the same sim­ple design template.

Easy pas­sages were read about as fast on both devices, but hard pas­sages actu­al­ly took longer to read on a mobile device ver­sus a com­put­er.  Easy arti­cles were about 400 words and writ­ten at a Grade 8 lev­el. Hard arti­cles were just under 1,000 arti­cles and at a Grade 12 level.

I would argue that tech­ni­cal com­mu­ni­ca­tion would typ­i­cal­ly fall into the hard category.

The take­away for me is again to sim­pli­fy your con­tent and to get to the point. You’re ask­ing a lot if you write a 1,000-word arti­cle when you know that some users will be read­ing the con­tent on a 5‑inch screen.

Challenge Number Three: Distraction Levels

Smart­phones have rev­o­lu­tion­ized how we live. But as mobile phones are portable, we are more like­ly to be inter­rupt­ed when using them. Nielsen notes that the aver­age user may be using a desk­top for more than 150 sec­onds while the aver­age mobile ses­sion dura­tion is just 72 seconds.

Nielsen rec­om­mends:

  • Allow users to save his­to­ry, as well as to email or share infor­ma­tion with them­selves or others.
  • Pri­or­i­tize what is essen­tial on a page and sim­pli­fy tasks and inter­ac­tions. Because atten­tion is frag­ment­ed, strive to show users what they need as soon as possible.

As users are more and more like­ly to read tech­ni­cal com­mu­ni­ca­tion on a mobile device, it’s an excit­ing time for tech­ni­cal writ­ers to learn new skills and approaches.

Filed Under: Career Development, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: mobile, research, smartphones, tablets, technical communications, technical writing, writing

FrameMaker 2017 Delivers New HTML5 Templates

August 14, 2017 by RDesprez Leave a Comment

FrameMak­er 2017 deliv­ers online help for mobile devices and includes two new respon­sive HTML5 help templates.

For years, FrameMak­er has been a lead­ing tool to cre­ate long and com­plex doc­u­ments. But if you required an online help sys­tem from FrameMak­er, you need­ed anoth­er soft­ware prod­uct, whether it was Web­Works (in the late 1990s) or Robo­Help (after 2005). A few years ago, Adobe changed all that, enabling FrameMak­er to cre­ate web- and mobile-friend­ly con­tent direct­ly from the soft­ware product.

FrameMak­er 2017 pro­vides two new respon­sive HTML5 tem­plates. Here’s an exam­ple of a help sys­tem for a fic­ti­tious prod­uct using the new “Indi­go” template:

Here’s the out­put using the “Ocean” tem­plate that comes with FrameMak­er 2017: 

FrameMaker’s Improved Search

In a world where users have embraced search, FrameMak­er 2017 includes some improve­ments by dis­play­ing key­words as you type in the search field. For exam­ple, when I start typ­ing a search query about “error mes­sages,” the respon­sive HTML5 starts pro­vid­ing sug­ges­tions on the fly, sim­i­lar to Google’s search engine. This “pre­dic­tive search” is avail­able in the respon­sive HTML5 help that is shipped with the lat­est ver­sion of FrameMaker.

Accord­ing to usabil­i­ty con­sul­tant Jakob Nielsen, users love search for two reasons:

  • Search lets users “con­trol their own des­tiny” and assert inde­pen­dence from com­pa­nies’ attempts to direct vis­i­tors on web sites.
  • Search is also users’ “escape hatch when they are stuck in nav­i­ga­tion.” When they can’t find a rea­son­able place to go next, they often turn to the site’s search function.

Giv­en that users love using search, it’s some­what sur­pris­ing that Nielsen found that they are often not very savvy when it comes to for­mu­lat­ing search queries.  He writes: “Typ­i­cal users are very poor at query refor­mu­la­tion: If they don’t get good results on the first try, lat­er search attempts rarely suc­ceed. In fact, they often give up.”

As cus­tomers increas­ing­ly focus on search to find rel­e­vant con­tent, the new search engine that is shipped with FrameMak­er 2017 is a wel­come addi­tion that should improve the user experience.

Filed Under: Help Authoring Tools, Online Reading, Online Writing, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: FrameMaker, mobile, responsive HTML5

Why are Technical Writers Slow to Embrace Mobile?

April 22, 2017 by RDesprez 3 Comments


Now that Android is the lead­ing oper­at­ing sys­tem used to con­nect to the Inter­net, tech­ni­cal writ­ers need to seri­ous­ly look at how their con­tent is being dis­played on smart­phones and tablets.

For years, smart­phone and tablet use has sky­rock­et­ed.  In 2016, the num­ber of smart­phone users was expect­ed to sur­pass 2 bil­lion (source: eMar­keter). Sim­i­lar­ly, there were about 1 bil­lion peo­ple world­wide in 2015 who used a tablet at least month­ly (source: eMar­keter). In the last few weeks, Android has edged out Win­dows as the num­ber one oper­at­ing sys­tem used to access the Inter­net.

Mean­while, tech­ni­cal writ­ers appear to be slow to embrace mobile. The Con­tent Wran­gler web site com­plet­ed a study last year of more than 700 tech­ni­cal com­mu­ni­ca­tion pro­fes­sion­als. The sur­vey found that 91 per­cent of firms sur­veyed pub­lish con­tent to the web. But only 24 per­cent of tech­ni­cal writ­ers pub­lish con­tent that would be con­sid­ered “mobile ready.”

Sur­prised? I am not.  Although tech­ni­cal com­mu­ni­ca­tions con­fer­ences are brim­ming with ideas about get­ting your con­tent ready for mobile, we are not embrac­ing the idea. You can­not blame the author­ing tools either. In the last few years, Help Author­ing Tools have pro­vid­ed new and for­ward-think­ing fea­tures that make it easy to cre­ate Respon­sive HTML5 and EPUB files. With Robo­Help, you can even cre­ate a mobile app that con­tains online help (I explain the basics of cre­at­ing a mobile app in a sep­a­rate blog post). In addi­tion, these tools are rel­a­tive­ly inex­pen­sive: you can pur­chase some of them on a month­ly sub­scrip­tion basis.

So why are more than 75 per­cent of tech­ni­cal writ­ers not writ­ing con­tent that is mobile ready? Here’s one guess: for all the talk about Dar­win Infor­ma­tion Typ­ing Archi­tec­ture (DITA), writ­ing con­tent for mobile, con­tent man­age­ment, and social media, there are still a lot of com­pa­nies that are using old approach­es and old tools, such as Microsoft Word, to write tech­ni­cal com­mu­ni­ca­tions. The Con­tent Wran­gler study appears to sup­port this the­o­ry with 49% of com­pa­nies sur­veyed still craft­ing print deliverables—just like it was done 20 years ago.

What do you think?

Filed Under: Help Authoring Tools, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: Help Authoring Tools, mobile apps, trends, writing for mobile

Which Output to Create: HTML5 or a Mobile App?

June 19, 2016 by RDesprez 3 Comments

New Help Author­ing Tools can cre­ate out­put files, such as HTML5 Help, mobile apps, and EPUB files. In this blog post, I am going to touch on what I see are the strengths of HTML5 Help and mobile apps.

First, some def­i­n­i­tions are in order. A mobile appli­ca­tion, most com­mon­ly referred to as an app, is a type of appli­ca­tion soft­ware designed to run on a mobile device, such as a smart­phone or a tablet com­put­er. HTML5 is a markup lan­guage used for struc­tur­ing and pre­sent­ing con­tent on the World Wide Web and is sup­port­ed by all mod­ern browsers. When I refer to HTML5 Help, I am refer­ring to a help project that can be viewed on com­put­ers, tablets, and smartphones.

The fol­low­ing image shows a screen cap­ture of an app for a fic­ti­tious prod­uct called InfoPath.

Mobile_app_example

The next image shows an HTML5 Help project that is dis­played on a computer.

HTML5_example

Strengths of Creating an App

  • The pop­u­lar­i­ty of apps is unde­ni­able. Eighty-five per­cent of users said they pre­fer using apps com­pared to mobile web sites. In addi­tion, users are spend­ing more time using apps—an increase of 21 per­cent in 2015 com­pared to the pre­vi­ous year. Source: Business2Community
  • Ide­al for users who have an inter­mit­tent con­nec­tion to the Inter­net: Once the app is installed on a smart­phone or tablet, it no longer requires a wire­less or mobile con­nec­tion to view the con­tent. In con­trast, HTML5 Help sys­tems require a brows­er, which usu­al­ly needs an Inter­net con­nec­tion to view the con­tent (although some browsers, such as Google Chrome, can run in offline mode).
  • Speed: Users will get the answers they need faster using an app ver­sus launch­ing a brows­er, nav­i­gat­ing to your help page, and wait­ing for the con­tent to appear.
  • High­er vis­i­bil­i­ty: An app is installed on a user’s smart­phone or tablet, mak­ing it easy to locate and launch. In con­trast, an online help sys­tem is typ­i­cal­ly includ­ed in a soft­ware pack­age and may not be easy to find or open.
  • Easy to cre­ate: I’ve cre­at­ed apps in Robo­Help (2015 release) and FrameMak­er (2015 release). Once you have per­formed some con­fig­u­ra­tion steps in both pro­grams, cre­at­ing an app is straight­for­ward.  Note: If you plan to cre­ate iOS appli­ca­tions, you need to pur­chase an Apple devel­op­er account for $99 US per year.

Aside the pre­vi­ous list, there are oth­er issues to con­sid­er, such as how will your app be dis­trib­uted to users so they can view your content.

Strengths of HTML5 Help

  • HTML5 Help auto­mat­i­cal­ly adjusts to the user’s screen: Respon­sive HTML5 Help changes the way the con­tent is pre­sent­ed, based on the device the user is using. For exam­ple, when view­ing con­tent on a PC, a user sees online help with a tra­di­tion­al lay­out while some­one using a smart­phone will see a table of con­tents that is opti­mized for touch. Respon­sive HTML5 Help auto­mat­i­cal­ly adjusts to the user’s screen and adjusts to dynam­ic screen size changes, such as a flip of the ori­en­ta­tion or resiz­ing of the brows­er. As a tech­ni­cal writer, you can author new con­tent or take your lega­cy con­tent and quick­ly out­put it so that it can be viewed on PCs, Macs, and smart­phones and tablets run­ning iOS and Android.

responsive-devices

Source for image: http://techwhirl.com/adobe-technical-communication-suite-2015-release-profile/)

  • Low learn­ing curve: A tech­ni­cal writer cre­ates Respon­sive HTML5 Help in much the same way as tra­di­tion­al help projects, such as Web­Help or Microsoft HTML Help. For any writer that has cre­at­ed online help in the past, cre­at­ing respon­sive HTML5 Help is straight­for­ward. In con­trast, cre­at­ing a mobile app requires some addi­tion­al con­fig­u­ra­tion steps, includ­ing pur­chas­ing an Apple devel­op­er account for iOS applications.
  • Con­sis­tent user expe­ri­ence across plat­forms: When using FrameMak­er or Robo­Help (2015 releas­es), one of the ben­e­fits of respon­sive HTML5 Help is it enables users to expe­ri­ence a sim­i­lar help system—including brand­ing and cor­po­rate col­ors that you can eas­i­ly customize—across devices. Whether your users are run­ning a PC, Mac, smart­phone, or tablet, the respon­sive HTML5 Help pro­vides a con­sis­tent user experience.

 

Filed Under: Help Authoring Tools, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog Tagged With: FrameMaker, HTML5 Help, mobile apps, RoboHelp

Creating a Mobile App for Android Devices

September 2, 2015 by RDesprez 6 Comments

Robo­Help (2015 release) makes it easy for tech­ni­cal writ­ers to gen­er­ate a mobile app for smart­phones and tablets run­ning iOS and Android.

You may con­sid­er cre­at­ing a mobile app for the fol­low­ing reasons:

  • Your users have an inter­mit­tent con­nec­tion to the Inter­net: Once the mobile app is installed on a smart­phone or tablet, it no longer requires a wire­less or mobile con­nec­tion to view the con­tent. In con­trast, HTML5 help sys­tems require a brows­er, which usu­al­ly needs an Inter­net con­nec­tion to view the con­tent (although some browsers, such as Google Chrome, can run in offline mode).
  • Speed: Users will get the answers they need faster using a mobile app ver­sus launch­ing a brows­er, nav­i­gat­ing to your help page, and wait­ing for the con­tent to appear.
  • High­er vis­i­bil­i­ty: A mobile app is installed on a user’s smart­phone or tablet, mak­ing it easy to locate and launch. In con­trast, an online help sys­tem is typ­i­cal­ly includ­ed in a soft­ware pack­age and may not be easy to find or open.

This pro­ce­dure explains how to use Robo­Help (2015 release) to cre­ate a mobile app for an Android phone or tablet. It also assumes you have some famil­iar­i­ty with cre­at­ing online help sys­tems and under­stand the basics of down­load­ing and installing mobile apps on Android smart­phones and tablets.

Creating a Mobile App

  1. In Robo­Help (2015 release), open a project that you want to con­vert to a mobile app.
  2. From the Out­put menu, click Mobile App.

List_of_outputs

  1. In the MobileApp Set­tings dia­log box, click Appli­ca­tion Details.
  2. In the Mobile App Details sec­tion, fill out the fol­low­ing fields:

a) Pack­age: A name that will unique­ly iden­ti­fy the mobile app such as “com.adobe.myapp.” This name is used by Phone­Gap to iden­ti­fy the appli­ca­tion. Phone­Gap is a mobile devel­op­ment frame­work to cre­ate mobile apps on iOS, Android, and Win­dows Phone. Phone­Gap’s web site is https://build.phonegap.com/

b) Ver­sion: The Phone­Gap ver­sion num­ber for the mobile app (for exam­ple, ver­sion 0.01).

c) Ver­sion­Code (Android): The Android ver­sion num­ber for the mobile app. If you upload your app to Android’s Google Play (the offi­cial app store for Android smart­phones and tablets), a user will be noti­fied of updates to your app every time you update the ver­sion number.

d) Title: The title of the appli­ca­tion that will dis­play on a mobile device.

e) Icon: The icon of the appli­ca­tion that will dis­play on a mobile device. For more infor­ma­tion about the rec­om­mend­ed icon sizes, see GitHub’s web page.

f) Splash Screen: The splash screen that will dis­play when the mobile app is opened on a mobile device. For more infor­ma­tion about the rec­om­mend­ed splash screen sizes, see GitHub’s web page.

  1. In the PhoneGap/Adobe Cre­den­tial sec­tion, type your Adobe User Name and Pass­word. As Phone­Gap is owned by Adobe, you can use the same web site cre­den­tials that you use when down­load­ing any Adobe prod­uct. After typ­ing your cre­den­tials, click Test Con­nec­tion to con­firm the Phone­Gap con­nec­tion. I found that this dia­log box didn’t rec­og­nize my cre­den­tials until I first logged on to PhoneGap’s web site.
  2. In the Plat­form sec­tion, select the Android check box.

Mobile_App_Settings

  1. In the Mobile App Set­tings dia­log box, click Con­tent.

a) In the Table of Con­tents drop­down list, select the table of con­tents you want to use for the mobile app.

b) If you cre­at­ed an index, in the Index drop­down list, select the index you want to use.

c) If you cre­at­ed a glos­sary, in the Glos­sary drop­down list, select the glos­sary you want to use.

d) Click Save and Gen­er­ate.

Robo­Help (2015 release) gen­er­ates the mobile app.

  1. Click View Result in the Result: Mobile App out­put has been gen­er­at­ed suc­cess­ful­ly dia­log box.

Downloading the Mobile App

The next step explains how to get the mobile app loaded onto your Android tablet or smartphone.

To down­load the mobile app to your Android phone:

  1. In your phone’s or tablet’s brows­er, type the URL that appears in the Mobile App Out­put dia­log box.
    Mobile_App_Output dialog box
  2. Alter­na­tive­ly, you can down­load the mobile app using a QR Reader.

a) Down­load a QR read­er to your Android phone. I down­loaded the QR Code Read­er from Google Play.

b) Using the QR read­er, scan the QR code in the Mobile App Out­put dia­log box.

The mobile app down­loads to your tablet or smartphone.

Viewing the Mobile App

Once the mobile app has been down­loaded and installed on your com­put­er, tap the mobile app you cre­at­ed. I haven’t attempt­ed to doc­u­ment down­load­ing and installing the app, due to the dif­fer­ent ver­sions of Android.

I cre­at­ed a sim­ple help app for a fic­ti­tious prod­uct called InfoPath. I cre­at­ed the icon in Snag­it and then import­ed the image into Robo­Help (2015 release). Here’s a screen shot of the down­loaded app on my phone:

2015-08-20 20.11.20

Here is an exam­ple of how the mobile app dis­plays when I open it.

2015-08-17 21.38.43

As an expe­ri­enced tech­ni­cal writer, I found cre­at­ing and down­load­ing a mobile app to be fast and straightforward.

Filed Under: Help Authoring Tools, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: app, Help Authoring Tools, mobile, RoboHelp

  • 1
  • 2
  • 3
  • 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,147 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 ·
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
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413050498957392

Image for twitter card

Brian Chesky Lost His Mind One Night—and Now He's Relaunching Airbnb as an Everything App

Airbnb's CEO is spending hundreds of millions to relaunch his travel company as an all-purpose service app. Fitness!...

www.wired.com

Reply on Twitter 1923413050498957392 Retweet on Twitter 1923413050498957392 0 Like on Twitter 1923413050498957392 0 Twitter 1923413050498957392
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923412665478627824

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister /via @globeandmail

Image for twitter card

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister

Experts say Solomon could face a host of challenges in his role, including how to increase AI adoption and comme...

www.theglobeandmail.com

Reply on Twitter 1923412665478627824 Retweet on Twitter 1923412665478627824 0 Like on Twitter 1923412665478627824 0 Twitter 1923412665478627824
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 May 1918126029463536113

This productivity poison is exhausting you /via @globeandmail

Image for twitter card

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
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.