Robert Desprez Communications

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

Online Conferences for Technical Writers in 2022

January 30, 2022 by RDesprez Leave a Comment

Here’s a list of inter­est­ing North Amer­i­can and vir­tu­al con­fer­ences. With the pan­dem­ic still with us, it seems that the num­ber of con­fer­ences has dwin­dled, com­pared to pre­vi­ous years.

Lava­con, Octo­ber 23 to 26, 2022, New Orleans, LA
http://lavacon.org

Mad­World Con­fer­ence, June 12 to 15, 2022, Austin, TX and online ver­sion
Mad­World

STC annu­al con­fer­ence, May 15 to 18, 2022, Rose­mont, IL
http://summit.stc.org/

Write the Docs, May 22 to 24, 2022, Port­land, OR
Write the Docs

Filed Under: Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology, Training Tagged With: career development, conferences, technical writer | Blog, technical writing, vancouver technical writer

Streamline your MadCap Flare Search Results

April 17, 2021 by RDesprez Leave a Comment

Tech­ni­cal writ­ers with large help projects may want to con­sid­er imple­ment­ing Mad­Cap Flare’s search fil­ter func­tion­al­i­ty to help users stream­line their search results.

By default, Flare cre­ates HTML5 files with­out search fil­ters. By tag­ging your con­tent with meta­da­ta and com­plet­ing some relat­ed steps, you can cre­ate help with fil­ters that you define. For exam­ple, when users search for a term, they can select the type of con­tent they want. The fol­low­ing screen cap­ture shows a user who typed Login in the search field and is look­ing for trou­bleshoot­ing content. 

Flare’s search engine will then only dis­play con­tent relat­ed to the Login search term that is also tagged as trou­bleshoot­ing material.

How to set up search filters

As Flare has already writ­ten doc­u­men­ta­tion on this fea­ture, I have includ­ed the main steps and linked to Flare’s help top­ics. The fol­low­ing steps assume you already have some famil­iar­i­ty with Flare. 

Note: If you click each of the links in the fol­low­ing steps, you will dis­cov­er that there are about 35 steps to per­form in mul­ti­ple and seem­ing­ly dis­parate areas of Flare’s inter­face. If you make a mis­take in any of steps, your out­putted help may not include search fil­ters. I think this is one of the fea­tures in Flare that could def­i­nite­ly be simplified—if I attempt­ed to recre­ate each of the steps and include screen cap­tures, I could eas­i­ly write the equiv­a­lent of 10 pages of content.

Here are the main steps:

  1. Add a fil­ter set to your project in the Project Orga­niz­er under the Advanced fold­er. For more infor­ma­tion, see https://help.madcapsoftware.com/flare2020r3/Content/Flare/Search/Search-Filter-Sets/Adding-Search-Filter-Sets-Projects.htm
  2. Add meta­da­ta or con­cepts to your top­ics in Flare. This step involves tag­ging all your top­ics into cat­e­gories. For exam­ple, if my Flare project con­tains trou­bleshoot­ing top­ics, I will need to tag each trou­bleshoot­ing top­ic with a “trou­bleshoot­ing” con­cept. The good news is that I found this step to be pret­ty quick. There are dif­fer­ent ways to tag your con­tent; I end­ed up using the “drag-and-drop method.” See https://help.madcapsoftware.com/flare2020r3/Content/Flare/Concepts/Inserting-Concepts1.htm
  3. Cre­ate a search fil­ter, which lets users nar­rows their search based on the con­cepts you’ve added to top­ics. For more infor­ma­tion, see https://help.madcapsoftware.com/flare2020r3/Content/Flare/Search/Search-Filter-Sets/Creating-Search-Filters.htm
  4. Add a search bar to an HTML5 skin. This step is just a quick check to make sure the search bar is con­fig­ured to dis­play in the head­er. See https://help.madcapsoftware.com/flare2020r3/Content/Flare/Search/Required-Activities/Including-Search-Bars.htm#HowtoEnabletheSearchBarinanHTML5Skin
  5. Asso­ciate a skin with a tar­get. This is also a quick step to make sure your edit­ed skin appears in the tar­get. See https://help.madcapsoftware.com/flare2020r3/Content/Flare/Skins/Process/Associating-Skins-Targets1.htm
  6. Asso­ciate a search fil­ter set with a tar­get. See https://help.madcapsoftware.com/flare2020r3/Content/Flare/Search/Search-Filter-Sets/Associating-Search-Filter-Set-Target.htm

Although there is some plan­ning and effort to imple­ment search fil­ters, most of these steps will only need to be per­formed once.

Filed Under: Help Authoring Tools, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Training

Adding Conditions to Microcontent in MadCap Flare 2020

May 30, 2020 by RDesprez Leave a Comment

Mad­Cap Flare 2020 adds improve­ments to its micro­con­tent fea­ture by sup­port­ing conditions.

In this blog post, I delve into the enhance­ments and pro­vide step-by-step instruc­tions on how you can mar­ry micro­con­tent with con­di­tions. Flare recent­ly cre­at­ed a post on some of the micro­con­tent improve­ments in the lat­est release of the soft­ware; this blog pro­vides addi­tion­al details.

What is microcontent?

Accord­ing to Flare’s online help, “Micro con­tent is short, con­cise infor­ma­tion that stands alone and is eas­i­ly con­sum­able.” Com­mon ways to use micro­con­tent in Flare include build­ing FAQs, work­ing with chat­bots, and adding micro­con­tent to search results. In this blog post, I explain how to add micro­con­tent in Mad­Cap Flare 2020 to your online help search results.

What does microcontent look like?

If you search for cer­tain terms, such as “con­di­tions” in Mad­Cap Flare’s online help, you see exam­ples of microcontent.

For years, Google has used the same par­a­digm. For exam­ple, type “how to pow­er wash” (I just bought a pow­er wash­er) and the search engine dis­plays a sum­ma­ry of the steps with­out me even hav­ing to click a website.

Add microcontent in Flare

First, I draft­ed a top­ic called “Adding Vari­ables” that includes five steps and two screen cap­tures. I con­di­tion­al­ized the images so they only appear in the topic.

I con­di­tion­al­ized the images with the Top­i­cOn­ly tag (I assume that you know how to con­di­tion­al­ize con­tent in Flare). This top­ic serves as the mas­ter for the microcontent.

To re-use the top­ic as microcontent:

  1. In Flare, click the Con­tent Explorer.
  2. Under Resources, click Micro­Con­tent.
  3. Right-click the Micro­Con­tent fold­er and select New > Micro Con­tent.
  4. In the Add File dia­log box, type a new name for your micro­con­tent in the File Name field and click Add.
  5. In the Micro­con­tent edi­tor, click the Add a phrase icon.
  6. Type a phrase for the micro­con­tent, such as “Vari­ables.” Phras­es are the key­words that you think users will type in the help’s search field when look­ing for a cer­tain topic.
  7. Option­al­ly, you can type alter­nate phras­es for the top­ic (for exam­ple, “Adding Vari­ables,” “Using Vari­ables,” and so on).
  8. Right-click the phrase(s) and select Add Link.
  9. In the Select File dia­log box, link the phrase to a top­ic (I linked my phrase to the Adding Vari­ables top­ic that I recent­ly cre­at­ed) and click OK.
  10. Right-click the phrase you added and select Prop­er­ties.
  11. Click Micro Con­tent Con­di­tions.
  12. In the list of Tags, select Default.TopicOnly and click Exclude. This step excludes the images that I added in the orig­i­nal help top­ic so they do not appear in the microcontent.
  13. Save your project.
  14. Gen­er­ate your help.

View the search results with microcontent

When users type the phrase “Vari­ables” in the search field, they see micro­con­tent that is based on the top­ic but does not dis­play any images as we con­di­tion­al­ized them to not dis­play. We are try­ing to just dis­play crit­i­cal con­tent in a con­cise way. Here’s an example:

Of course, the full top­ic is also avail­able in the help includ­ing the images.

Why is this a welcome improvement?

This enhance­ment is a worth­while devel­op­ment as you can re-use exist­ing top­ics and opti­mize the con­tent so it’s ide­al­ly suit­ed for micro­con­tent. For depart­ments who are already using micro­con­tent, this fea­ture is a wel­come addition.

Filed Under: Help Authoring Tools, Online Writing, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: conditions, Madcap Flare, microcontent, single-sourcing

Online Learning Resources for Technical Writers

April 12, 2020 by RDesprez Leave a Comment

Once a year, I com­pile a list of upcom­ing tech­ni­cal writ­ing con­fer­ences in North Amer­i­ca and pub­lish a blog post. With the coro­na virus affect­ing all aspects of our lives, take a look at the Soci­ety for Tech­ni­cal Communication’s online con­fer­ence in May and some online resources to investigate.

STC Virtual Conference (May 17 to 20, 2020)

https://summit.stc.org/

There are some addi­tion­al “in-per­son” tech­ni­cal writ­ing con­fer­ences sched­uled for lat­er in the sum­mer and fall. I expect that these events will be post­poned or re-imag­ined as vir­tu­al events.

MadCap’s webinars

https://www.madcapsoftware.com/resources/recorded-webinars.aspx#flare

Adobe’s webinars

https://meetus.adobeevents.com/technicalcommunication/

Lynda.com courses

In the region I live, the local library offers res­i­dents a free mem­ber­ship to Lynda.com. If you don’t already have a paid mem­ber­ship, you may want to check whether your library pro­vides com­pli­men­ta­ry access. Here is a sam­pling of some cours­es relat­ed to tech­ni­cal writing.

Acro­bat DC Essen­tial Training

GitHub

Work­ing Remotely

Learn­ing Confluence

Instruc­tion­al Design

Get­ting Start­ed in User Experience

List of Good Technical Writing Books

List of books

Podcast on Technical Writing Trends for 2020

Pod­cast

Other Online Resources

While not spe­cif­ic to tech­ni­cal writ­ing, here’s a list of pop­u­lar mas­sive open online cours­es (MOOCs),  online pro­grams with unlim­it­ed par­tic­i­pa­tion and open access via the Inter­net. The list includes a diverse selec­tion of cours­es on arti­fi­cial intel­li­gence, phi­los­o­phy, the chem­istry behind cook­ing, the future of sto­ry­telling, pro­gram­ming, and learn­ing how to learn.

I hope you find this list help­ful. Stay healthy!

Filed Under: Career Development, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology, Training Tagged With: massive open online courses, MOOCs, online courses, technical writing, virtual conferences

Exceeding Client Expectations

October 26, 2019 by RDesprez 2 Comments

When peo­ple talk about tech­ni­cal com­mu­ni­ca­tions jobs or trends, employ­ers do not bring up cus­tomer ser­vice skills as a top skill.

While most of our jobs may be focused on writ­ten com­mu­ni­ca­tions or know­ing a col­lec­tion of soft­ware tools or tech­nol­o­gy skills, we still reg­u­lar­ly meet with col­leagues both with­in and out­side of depart­ments. Cus­tomer ser­vice skills come into play when we inter­act with col­leagues, respond to emails, take respon­si­bil­i­ty for mis­takes, pro­duce qual­i­ty con­tent on time, col­lab­o­rate and share knowl­edge, and man­age expectations.

Recent­ly, I read two books about cus­tomer ser­vice: The Star­bucks Expe­ri­ence: 5 Prin­ci­ples for Turn­ing Ordi­nary Into Extra­or­di­nary and Be Our Guest: Per­fect­ing the Art of Cus­tomer Ser­vice, a book that focus­es on Disney’s approach when it comes to exceed­ing expec­ta­tions rather than sim­ply sat­is­fy­ing them.

Here are a few things that I think about when work­ing for clients:

  • Be diplo­mat­ic: As a con­sul­tant, I real­ized the impor­tance of diplo­ma­cy more than five years ago. At one client site, I wit­nessed a con­sul­tant say the wrong thing to the wrong employee—the next day the con­sul­tant was fired.
  • Make an effort to meet col­leagues and clients in per­son: Even if I am not required to vis­it a client’s office reg­u­lar­ly, I still make the effort to phys­i­cal­ly be there, espe­cial­ly at the start of a project. I know it is more con­ve­nient to set up an online meet­ing. But vis­it­ing a client reg­u­lar­ly sends a mes­sage that the client and their work are impor­tant. In my expe­ri­ence, meet­ing the per­son helps build trust and often makes the sub­se­quent review of tech­ni­cal doc­u­men­ta­tion that much eas­i­er. Think of that first meet­ing as an investment.
  • Be approach­able and lik­able: I know this is obvi­ous but it’s worth repeat­ing. First impres­sions mat­ter and being friend­ly and easy to approach when you first start work­ing at a com­pa­ny makes your work that much eas­i­er in the days and weeks that follow.
  • Man­age expec­ta­tions: If you tell a client or col­league that you will do some­thing by a cer­tain date, make sure you do it. Even bet­ter, if you say you will deliv­er con­tent to the client by Fri­day, pro­vide the con­tent a day or two ear­ly. I am fre­quent­ly sur­prised how many peo­ple make a promise and do not fol­low through.
  • Lis­ten well. When I meet sub­ject mat­ter experts, I talk less and lis­ten to their needs. For long meet­ings, you may want to con­sid­er using note-tak­ing tools. Check out this pod­cast on note-tak­ing tools and technologies.
  • Respond to crit­i­cism or mis­takes quick­ly. We all make mis­takes. If you’ve made a mis­take, own up to it, fix the issue quick­ly, and learn from it.
  • Sur­prise and delight: In The Star­bucks Expe­ri­ence, author Joseph Michel­li writes, “Nowa­days, peo­ple have a cer­tain antic­i­pa­tion for some­thing spe­cial with just about every pur­chas­ing expe­ri­ence, or hope they will get sur­prised, even in the most mun­dane expe­ri­ences.” With this in mind, how can tech­ni­cal writ­ers sur­prise and delight clients and super­vi­sors? One way is to go “above and beyond” what is asked of you. For exam­ple, if your client asks you to re-write an online top­ic, you could improve the top­ic but also add an illus­tra­tion that clar­i­fies a con­cept as well as improve an aspect of the website’s navigation.
  • Stream­line process­es. When you inter­act with col­leagues, make it easy as pos­si­ble to inter­act with you. In my opin­ion, reviews of tech­ni­cal con­tent are often cum­ber­some and are typ­i­cal­ly han­dled by send­ing draft PDF files to Sub­ject Mat­ter Experts, who edit the PDF and email it back. After a few months, writ­ers have col­lect­ed dozens of these PDFs from Sub­ject Mat­ter Experts in an email pro­gram. In con­trast, at one client site I worked at, they used Con­flu­ence to post PDFs so that Sub­ject Mat­ter Experts could eas­i­ly review and com­ment on the draft con­tent. Even bet­ter, Sub­ject Mat­ter Experts could see what oth­er review­ers had writ­ten on a giv­en top­ic, fos­ter­ing a dia­log on con­tentious issues. Fur­ther­more, writ­ers could respond to the draft com­ments by mak­ing com­ments back, such as “Made the edit in the source file.” Check out an ear­li­er blog post I wrote about using Con­flu­ence to man­age tech­ni­cal con­tent reviews.
  • End a project or con­tract in a pos­i­tive way: Every con­tract comes to an end. When a con­tract is ramp­ing down, I make an effort to sur­prise clients in a pos­i­tive way. Recent­ly, I vol­un­teered myself to write some depart­men­tal pro­ce­dures that I knew were lack­ing and need­ed. I feel that end­ing a con­tact in a pos­i­tive way may increase the chances of being called back for future projects.

 What do you think? When it comes to cus­tomer ser­vice skills, how do you exceed cus­tomer expectations?

Filed Under: Career Development, Professional Development, Robert Desprez | Vancouver technical writer | Blog Tagged With: customer service, exceed expectations

  • « Previous Page
  • 1
  • 2

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.