Robert Desprez Communications

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

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

How to use illustrations to make your
technical docs clearer

September 27, 2013 by RDesprez 3 Comments

Images can be a suc­cinct and effec­tive way to con­vey a mes­sage. Yet I don’t see many illus­tra­tions being used in tech­ni­cal com­mu­ni­ca­tions. Many writers—including me—don’t think their strength is illustrating.

Dan Roam, in his book The Back of the Nap­kin, argues that one does­n’t have to be a gift­ed artist or use Adobe Illus­tra­tor or Microsoft Pow­er­Point to cre­ate effec­tive images. Draw­ings can be as sim­ple as hand-drawn pic­tures, he says. Indeed, his book is brim­ming  with draw­ings that resem­ble doo­dles. One of my favorite things about Roam’s book is that he offers a frame­work that helps read­ers think about how to approach illustrating.

Here are some of the draw­ings he discusses:

  • Por­traits: To explain a con­cept that address­es the “who” or “what,” Roam rec­om­mends using a qual­i­ta­tive dia­gram. For exam­ple, many peo­ple strug­gle with under­stand­ing the term “meta­da­ta.” You could try to define it (such as “it’s data about data.”) But that def­i­n­i­tion often leaves peo­ple still scratch­ing their heads. An alter­na­tive solution—you could draw it.

Example of metadata

In short, meta­da­ta pro­vides more details about a doc­u­ment, such as who wrote the file, when the per­son wrote it, the point of the doc­u­ment, and so on.

  •  Charts: If you’re try­ing to com­mu­ni­cate a quan­ti­ty, writ­ing about it may suf­fice. But if you’re per­form­ing a com­par­i­son, a pie chart or bar chart is the best choice. Here’s a fic­ti­tious example:

example_chart

  • Time­lines: To explain a process or work­flow, you could try explain­ing each step. Anoth­er way to accom­plish the same thing is by using a sim­ple work­flow dia­gram, which explains “when” some­thing hap­pens in a process. For work­flows, I fre­quent­ly use Microsoft Office’s Smar­tArt fea­ture. Here’s a sam­ple work­flow I cre­at­ed that con­veys a com­mon­ly used approach to cre­at­ing tech­ni­cal documents:

Authoring_process

  • Maps: When explain­ing the rela­tion­ship of one object to anoth­er, Roam rec­om­mends you use a map. When I think of maps, I tend to think of street maps. But that’s too nar­row a def­i­n­i­tion. Maps can show all sorts of things. From Roam’s book, here’s one exam­ple that explains the rela­tion­ship among objects:

Example of a map

Here’s anoth­er screen cap­ture from Roam’s book that shows an orga­ni­za­tion­al chart, which is just anoth­er type of map:

Organizational chart

  •  Flow­charts:  Flow­charts are tools that explain “how” a process works. If you’re seri­ous about flow­charts, you could use Visio. For end-user doc­u­men­ta­tion, I find Visio dia­grams too tech­ni­cal look­ing and uninvit­ing. I cre­at­ed this sim­ple flow­chart in Pow­er­Point that explains one way to review tech­ni­cal documents:

Example of flowchart

In this blog entry, I’ve just scratched the sur­face of Roam’s book. The Back of the Nap­kin is well worth a read for tech­ni­cal writ­ers who want to diver­si­fy their skill set and use visu­al think­ing to work through com­plex tech­ni­cal concepts.

Filed Under: Career Development, Robert Desprez | Vancouver technical writer | Blog Tagged With: career development, illustrations, online writing, technical writing, using graphics

Are you settling for too little?

July 25, 2013 by RDesprez 2 Comments

Remem­ber the Greek myth of Icarus?

Mas­ter craft­man Daedalus craft­ed a set of wings made out of wax and feath­ers for his son, Icarus, so that he could escape Crete. Daedalus warned his son not to fly too close to the sun or his wings would melt. Icarus didn’t heed his father’s advice and end­ed up soar­ing too high. His wings melt­ed, he plum­met­ed to the ocean, and died.

The cau­tion­ary tale that we learned from the sto­ry: lis­ten to your par­ents, don’t dis­obey your elders, and don’t dis­re­gard the rules.

Writer and busi­ness mar­keter Seth Godin argues in his book The Icarus Decep­tion that there’s anoth­er part of the myth that isn’t wide­ly known. Daedalus also remind­ed his son not to fly too close to the ocean because the water would ruin his wings.

Writes Godin: “It’s far more dan­ger­ous to fly too low than too high, because it feels safe to fly low. We set­tle for low expec­ta­tions and small dreams and guar­an­tee our­selves less than we are capa­ble of. By fly­ing too low, we short­change not only our­selves but also those who depend on us or might ben­e­fit from our work.”

Image of Icarus

He argues that cit­i­zens need to fly high­er than ever, not “play it safe.” He spends most of the book argu­ing that economies reward art, not com­pli­ance. In the past, work­ers were reward­ed for play­ing by the rules. Not any more.

Godin argues that the fol­low­ing traits are impor­tant in the new economy:

Trust and per­mis­sion: We do busi­ness with those indi­vid­u­als and orga­ni­za­tions that have earned our atten­tion. “We seek out peo­ple who tell us sto­ries that res­onate, we lis­ten to those sto­ries, and we engage with those people…who delight.”

Remark­a­bil­i­ty: We are drawn to those com­pa­nies or indi­vid­u­als that stand out, who are dif­fer­ent. No one sits around talk­ing about the com­pa­ny or per­son who blends in with every­one else.

Lead­er­ship: Lead­ers are com­pa­nies and indi­vid­u­als who take risks and take us all to a dif­fer­ent place. An obvi­ous exam­ple is Steve Jobs, who rev­o­lu­tion­ized how we lis­ten to music and over­saw the cre­ation of the iPhone and iPad.

Sto­ries that spread: This involves deliv­er­ing a mes­sage that is worth­while to spread. “After trust is earned and your work is seen, only a frac­tion of it is mag­i­cal enough to be worth spread­ing. Again this mag­ic is the work of the human artist, not the cor­po­rate machine,” writes Godin.

Human­i­ty: Instead of focus­ing on just the cheap­est prod­uct, we focus on orig­i­nal­i­ty and car­ing instead.

How do these traits apply to tech­ni­cal communications?

Cred­i­bil­i­ty and trust: We must ensure that the con­tent that we write is tech­ni­cal­ly accu­rate. Not real­ly sur­pris­ing, giv­en that this is the pri­ma­ry respon­si­bil­i­ty of our jobs. When I start­ed in this career, I tend­ed to rely on Sub­ject Mat­ter Experts to vet my con­tent. Some SMEs are excel­lent at review­ing tech­ni­cal doc­u­ments; most don’t have the time or inter­est to review large doc­u­ments. I real­ized that it’s ulti­mate­ly up to me to make sure the con­tent is as accu­rate as pos­si­ble. Over time, I try to immerse myself in the sub­ject so that I become a qua­si-SME on a sub­ject.  In addi­tion, I strive to do what I say I will do. It is sim­ple advice but it’s sur­pris­ing how many peo­ple will say one thing and do anoth­er. Or do nothing.

Remark­a­bil­i­ty: Scan most tech­ni­cal com­mu­ni­ca­tion job adver­tise­ments and com­pa­nies want some vari­a­tion of the fol­low­ing skills:

  • Expe­ri­ence with dif­fer­ent author­ing tools: Word, FrameMak­er, Mad­cap Flare, Acro­bat, Robo­Help, Share­Point, Cap­ti­vate, and so on.
  • Demon­strat­ed writ­ing skills and a relat­ed cer­tifi­cate or degree.
  • Abil­i­ty to jug­gle mul­ti­ple priorities.
  • Abil­i­ty to work well with others.
  • Demon­strat­ed self-starter.
  • And so on…

For a giv­en job, let’s say 20 can­di­dates apply for the job, includ­ing you. How are you dif­fer­ent? What skills and per­son­al­i­ty do you pos­sess that are dif­fer­ent than the oth­er can­di­dates? Being the same as every­one else—essentially blend­ing in—is not a strength. Per­haps you have expe­ri­ence writ­ing con­tent for mobile? Have you worked as an instruc­tion­al design­er or busi­ness ana­lyst? Do you have deep domain knowl­edge on a giv­en sub­ject? Is your atti­tude a dif­fer­en­tia­tor? Do you guar­an­tee your work?

I’d sug­gest you think about and cul­ti­vate your dif­fer­en­tia­tors so you stand out from the pack.

Mak­ing con­nec­tions: Tech­ni­cal writ­ers gen­er­al­ly aren’t the life of the par­ty. They don’t go out of their way to con­nect with oth­ers. They focus on their deliv­er­ables, not fos­ter­ing a network.

There are excep­tions. There’s one writer I know who real­ly makes an effort to meet oth­ers for a cof­fee. He enjoys it. And he ben­e­fits from this effort: he fre­quent­ly hears of con­tract jobs before they are adver­tised. Oth­er writ­ers rec­og­nize that he excels at networking.

As writ­ers, we could all ben­e­fit from mak­ing con­nec­tions with oth­ers, whether it’s anoth­er writer, or anoth­er con­trac­tor on your team, or a poten­tial employer.

Do you agree? How can tech­ni­cal writ­ers demon­strate trust, remark­a­bil­i­ty, lead­er­ship, sto­ry­telling, and an abil­i­ty to make connections?

Filed Under: Career Development Tagged With: career development, technical writers, writing

Are we facing a “skills gap” in Information Technology?

August 1, 2012 by RDesprez 12 Comments

What new skills have you learned on your own time in the last six months?

If you’re like many IT peo­ple, you may be defer­ring to your boss when it comes to career devel­op­ment. Per­haps your com­pa­ny is ready to imple­ment a new Share­Point site and you’ve been immersed in that project for the last six months. Great. But have you been keep­ing your eye on indus­try trends on what skills are emerg­ing and those that are wan­ing? I sus­pect most peo­ple work­ing it IT would say “no.”

The June 4th edi­tion of Com­put­er­World mag­a­zine argues that com­pa­nies have lots of job open­ings but there are still many IT work­ers who are strug­gling to land jobs. The rea­son? A skills gap. The jobs are there but work­ers’ skills are not.

Todd Wein­man, a recruiter quot­ed in the arti­cle, said: “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.”

Employ­ers are clam­or­ing for can­di­dates with exper­tise in mobile app devel­op­ment, cloud com­put­ing, and busi­ness ana­lyt­ics, accord­ing to the arti­cle. But employ­ees may be tired of the self-devel­op­ment treadmill—especially if they are work­ing more than 50 hours per week.

Accord­ing to the arti­cle, here are some sug­ges­tions for thriv­ing in IT in the com­ing years:

* Cre­ate your own train­ing plan. Accord­ing a recent arti­cle pub­lished by the Har­vard Busi­ness Review, set aside a few hours each week on career development.

* Pur­sue train­ing and cer­ti­fi­ca­tions on your own time and at your expense. On a relat­ed note, I recent­ly read a book called the Six Fun­da­men­tals of Suc­cess by Stu­art R. Levine. Levine writes: “Take con­trol of your con­tin­u­ing edu­ca­tion and per­son­al growth.  Every six months, give your­self spe­cif­ic learn­ing goals…Too often peo­ple wait for their boss to tell them what skills they need. This is a stun­ning abdi­ca­tion of responsibility.”

* Devel­op soft skills, like com­mu­ni­ca­tion.

* Iden­ti­fy dif­fer­ent class­es of skills. Which tech­nolo­gies are emerg­ing, main­stream, and or lega­cy? Does your cur­rent exper­tise have a long future ahead of it? If not, what cer­ti­fi­ca­tions and train­ing do you need?

Here’s my take on it. I’ve worked about 15 years in IT and work­ers who enjoy learn­ing and are moti­vat­ed to learn appear to do bet­ter in the work­place. In con­trast, those employ­ees who decide to go on “career cruise con­trol” become vul­ner­a­ble dur­ing lay­offs because their skills are per­ceived to be “rusty.”

Obvi­ous advice? Per­haps. But many work­ers don’t seem to fol­low it. What do you think about this issue?

Check out the Com­put­er­World arti­cle.

 

Filed Under: Career Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: career development, Information Technology, IT, technology

Is writing for mobile the next big thing?

April 29, 2012 by RDesprez 10 Comments

With all the news about the sky­rock­et­ing demand for smart­phones over­tak­ing com­put­er pur­chas­es, you might think that tech­ni­cal writ­ers would increas­ing­ly need to focus on writ­ing and deliv­er­ing user assis­tance for mobile devices.

For tech­ni­cal writ­ers, writ­ing for mobile appears to be the next big thing. Here are a few examples:

  • Mobile devices will be the pri­mary con­nec­tion tool to the Inter­net for most peo­ple by 2020, accord­ing to the Pew Research service.
  • Ref­er­ences to mobile phones and tablets are abun­dant at the Writ­er­sUA con­fer­ence and the upcom­ing Soci­ety for Tech­ni­cal Com­mu­ni­ca­tion conference.
  •  Help author­ing tools such as Mad­Cap Flare and Robo­Help tout that they sup­port pub­lish­ing con­tent for mobile devices using the ePub output.
  • There’s even a book ded­i­cat­ed to the top­ic called Devel­op­ing User Assis­tance For Mobile Apps by Joe Welinske.

So along with social media, one might think that cre­at­ing user assis­tance for mobile devices will rev­o­lu­tion­ize the way we work. There’s one prob­lem though.  In the last year, I have yet to see one job descrip­tion in Van­cou­ver that explic­it­ly refers to prepar­ing con­tent for mobile devices. When it comes to tech­ni­cal writ­ing oppor­tu­ni­ties, Van­cou­ver is no Sil­i­con Val­ley but it’s not unusu­al to see five to 10 adver­tised jobs per month.

I don’t think any­one can argue that cre­at­ing user assis­tance for mobile devel­op­ment is too new. Accord­ing to Apple’s web site, there are report­ed­ly 500,000 appli­ca­tions for the iPhone and iPad. There are also thou­sands of appli­ca­tions that run on the Android oper­at­ing sys­tem.  And smart­phones have been avail­able for years. So why is there not a surge in demand for user assis­tance for mobile devices? Some guesses:

  • Soft­ware devel­op­ers are writ­ing the con­tent. While the user assis­tance writ­ten by devel­op­ers may not be pro­fes­sion­al­ly writ­ten and for­mat­ted, per­haps man­age­ment feels that the con­tent  is “good enough”? After all, if a mobile app requires a lot of doc­u­men­ta­tion, it prob­a­bly means that it’s dif­fi­cult to use. Users expect apps to be simple.
  • Per­haps writ­ing for mobile is not big as pre­dict­ed. Employ­ers in Van­cou­ver are not clam­or­ing for writ­ers with mobile expe­ri­ence.  To be fair, I searched for “tech­ni­cal writer mobile” on the U.S. job site www.dice.com and found that 41 of 649 jobs men­tioned “mobile” in the job descrip­tions. Hard­ly a tsunami!
Do you think writ­ing user assis­tance for mobile will be the next thing? Why is there not a stronger demand? I’d be inter­est­ed in your thoughts.

 

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

  • « Previous Page
  • 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,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 ·
17h 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.