Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me
You are here: Home / Online Writing for Mobile / GOOD PRACTICES FOR CREATING ONLINE HELP FOR MOBILE DEVICES

GOOD PRACTICES FOR CREATING ONLINE HELP FOR MOBILE DEVICES

May 21, 2011 by RDesprez 8 Comments

Tweet

I believe that tech­ni­cal writ­ers will need to think more and more about cre­at­ing online help for mobile devices as smart­phone sales sky­rock­et. Accord­ing to the Pew Research ser­vice, mobile devices will be the pri­ma­ry con­nec­tion tool to the Inter­net for most peo­ple by 2020.

With that in mind, I’ve start­ed read­ing more about cre­at­ing user assis­tance for mobile appli­ca­tions. Joe Welinske, the pres­i­dent of Writ­er­sUA, recent­ly wrote a series of webi­na­rs about mobile user assis­tance. I pur­chased the first webi­nar titled “UA in Mobile Plat­forms.” In it Welinske writes, “The sin­gle most impor­tant thing I have learned in my work with mobile apps is that bring­ing over Help designs from desk­top appli­ca­tions is a real­ly bad idea.”

So what are some good prac­tices for cre­at­ing help on mobile appli­ca­tions? As I am just learn­ing about the sub­ject myself, here are some rec­om­men­da­tions that I’ve gleaned. One real­ly good arti­cle on the sub­ject is “A User-Cen­tered Approach to Web Design For Mobile Devices” by Lyn­don Cere­jo. Here are some of Cerejo’s and Welinske’s rec­om­men­da­tions that can be applied to help:

Design for a small screen size

Unfor­tu­nate­ly, there is not one stan­dard screen size (this reminds me of the brows­er wars from years ago). To com­pli­cate mat­ters, some phones can change ori­en­ta­tion and users expect the web site to resize accordingly.

Simplify navigation

  • Reduce the num­ber of cat­e­gories and lev­els of nav­i­ga­tion, and rearrange con­tent based on pri­or­i­ty, pre­sent­ing the most impor­tant cat­e­gories first.
  • Use clear, con­cise and con­sis­tent labels for nav­i­ga­tion across the site.
  • When design­ing for touch, make sure the tap size (width or height) for the nav­i­ga­tion item is at least 30 pixels.
  • Bread­crumbs are usu­al­ly not used on mobile sites since nav­i­ga­tion is not usu­al­ly so deep that users need a trail back.
  • Make links obvi­ous, and pro­vide clear and imme­di­ate visu­al feed­back to show the select­ed link.
  • Be suc­cinct because of the small screen size.
  • Use short and descrip­tive titles for your pages.
  • If you must include scrolling, scroll in only one direc­tion. Most mobile sites scroll vertically.

Design for intermittent connectivity

Cell phone com­pa­nies are offer­ing faster net­works but it doesn’t mean the ser­vice is always avail­able. And not all users have unlim­it­ed data plans. So make sure that pages can be loaded quick­ly on a mobile device, and that images are rel­a­tive­ly small.

Search and indexes

Welinske believes index­ing and search tech­niques are of less use in mobile appli­ca­tions. “If a user needs to search for Help con­tent, then the user assis­tance is far too large.”

Design for a distracted user

Cere­jo argues that you can­not con­trol where cus­tomers will use the phone or even how it will be used. Here’s a quote from his arti­cle: “Pic­ture a mobile user try­ing to find direc­tions using a tiny phone with inter­mit­tent con­nec­tiv­i­ty, while strap hang­ing and sway­ing in a sub­way train with sub-opti­mal light­ing con­di­tions, deaf­ened by the screech­ing of wheels on tracks — that gives you some con­text of use. Sim­ply put, con­text is about the envi­ron­ment and con­di­tions of usage, includ­ing dis­trac­tions, mul­ti­task­ing, motion, light­ing con­di­tions and poor connectivity.”

Summary

In the next decade, most peo­ple will be using their cell phones to con­nect to the Inter­net. If this pre­dic­tion holds true, tech­ni­cal writ­ers will need to mas­ter deliv­er­ing help on smart­phones too. It will be an excit­ing and chal­leng­ing ride.

Filed Under: Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog Tagged With: best practices, mobile, smartphones, writing

Comments

  1. Kris says

    March 17, 2012 at 4:27 pm

    Nice arti­cle.

    I am using Robo­Help to cre­at­ing chm and web help for some of our applications.

    I was won­der­ing if I can use Robo­Help to cre­ate Help for an appli­ca­tion that would be inte­grat­ed in iPhone and Win­dows Phone.
    If Yes, Can you guide me how to accom­plish that in the best pos­si­ble manner?

    Thanks.

    Reply
  2. Simon says

    March 17, 2012 at 4:27 pm

    Mad­Cap Flare has a Mobile Out­put that you may want to try.

    Reply
  3. Robert Desprez says

    March 17, 2012 at 4:28 pm

    Hi Kris,

    Yes, you can con­vert your online help from Robo­Help to an EPUB for­mat (which runs on an iPad and mobile phones) pro­vid­ed you have Adobe Tech Comm Suite 3, which was released this year.

    This YouTube video shows you an overview. 

    http://www.youtube.com/watch?v=8X1EOIZSu2U&feature=youtube_gdata_player

    Let me know if you have any oth­er questions.

    Reply
  4. Nora Bencsics says

    March 17, 2012 at 4:28 pm

    It was inter­est­ing read­ing this. Does this also apply to doc­u­men­ta­tion for Apple products?

    Recent­ly my sis­ter received an IPAD2 mobile device for her birth­day (yes, a nice gift!). I’ve always used PC-based devices, so help­ing her nav­i­gate her new toy, which is Apple-based, was a bit of a chal­lenge. The biggest chal­lenge of all is that for some rea­son, Apple pro­vides min­i­mal doc­u­men­ta­tion for its prod­uct. We went into an Apple store to get some help (the doc­u­men­ta­tion I was able to track down on the Inter­net was scanty, poor­ly orga­nized, and — as it turned out — con­tained pro­ce­dur­al errors). The fel­low at the counter agreed that Apple just does­n’t pro­vide much in the way of doc­u­men­ta­tion, believ­ing their prod­uct is so intu­itive that it does­n’t require it. And if peo­ple do require assis­tance, Apple sup­plies seminars! 

    While I don’t see Apple over­tak­ing the PC desk­top and device world, nev­er­the­less as a tech­ni­cal writer the above made me think about what kind of impact this approach to prod­uct deliv­ery will have on the tech­ni­cal writ­ing profession.

    Reply
  5. Robert Desprez says

    March 17, 2012 at 4:29 pm

    Hi Nora,

    Sor­ry for the slow response. Yes, I’m pri­mar­i­ly refer­ring to mobile help for devices designed by Apple, as the com­pa­ny is a leader in the mobile market.

    Yes, I too, have expe­ri­enced Apple’s min­i­mal­ist doc­u­men­ta­tion on my iPhone. The con­tent is avail­able but it’s tucked away in Safari. Agreed–it is not ide­al: some func­tion­al­i­ty isn’t obvi­ous on an Apple product.

    Thanks for your comment!

    Reply
  6. Kushal Raut says

    March 17, 2012 at 4:29 pm

    Hi,

    This is real­ly news to me (scary or oth­er­wise, only future will decide)!! If more and more peo­ple start using their smart­phones to con­nect to the Inter­net, we (the writ­ers) will sure­ly have to catch up, and fast. The tech­comm world sure­ly depends on tech­nol­o­gy, which is evolv­ing faster than ever. Thanks for a very infor­ma­tive arti­cle Robert.

    Reply
  7. Robert says

    March 17, 2012 at 4:30 pm

    You’re wel­come Kushal!

    Reply

Trackbacks

  1. Good practices for creating help on mobile devices | TechWhirl says:
    April 9, 2012 at 6:40 pm

    […] out my blog: https://robertdesprez.com/Site_3/Blog/Entries/2011/5/21_GOOD_PRACTICE… Share via […]

    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,184 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 ·
2 Oct 1973868879261938086

Image for twitter card

The magic of AI is giving way to complaints about workslop

A team from Better Up Labs and the Stanford Social Media Lab define workslop as ‘AI generated work content tha...

www.theglobeandmail.com

Reply on Twitter 1973868879261938086 Retweet on Twitter 1973868879261938086 0 Like on Twitter 1973868879261938086 0 Twitter 1973868879261938086
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 Oct 1973599012268941339

What a great website to book a BC ferry, if they are reserved. I just bought Vedran B a coffee on @buymeacoffee! 🎉

You can support them here —

Image for twitter card

Vedran B

I created https://nextsailing.ca as a free tool to help locals from the Lower Mainland and Vancouver Island book t...

buymeacoffee.com

Reply on Twitter 1973599012268941339 Retweet on Twitter 1973599012268941339 0 Like on Twitter 1973599012268941339 0 Twitter 1973599012268941339
robert_desprez avatar; Robert Desprez @robert_desprez ·
27 Sep 1972079492962439576

Image for twitter card

Opinion: Big Tech’s flattery of Trump is getting them nowhere

With the new price tag on H-1B visas, tech companies are learning that currying favour with Trump is a losing game

www.theglobeandmail.com

Reply on Twitter 1972079492962439576 Retweet on Twitter 1972079492962439576 0 Like on Twitter 1972079492962439576 0 Twitter 1972079492962439576
robert_desprez avatar; Robert Desprez @robert_desprez ·
23 Sep 1970576226126541085

Image for twitter card

Is AI the learning tool of the future, or should we be worried about its use in higher education?

Many students are already using AI to conduct research, summarize readings and write essays. On Machines Like Us, ...

www.theglobeandmail.com

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

Recent Blog Posts

  • Using ChatGPT to read smarter
  • ChatGPT: The AI-powered proofreader
  • Four ways Confluence could be better
  • First impressions of MadCap’s purchase of IXIASOFT

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.