Robert Desprez Communications

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

Four Ways Confluence Could Be Better

March 17, 2023 by RDesprez Leave a Comment

Years ago, I used Con­flu­ence and then recent­ly used it again at a client site. I liked it when I first used it but feel dis­ap­point­ed that it does not seem to have evolved. Here are four ways that it could be improved.

What is Confluence?

In case you have not used it, Con­flu­ence is a soft­ware prod­uct that makes it easy to col­lab­o­rate across an enterprise.

Import content from PDFs and Word files

On a past project, I import­ed many old­er Word files and PDFs into Confluence.

The Word and PDF files were very dif­fer­ent from the new tem­plate found in Con­flu­ence so I resort­ed to copy­ing con­tent from the source file to the new tem­plate. Even if I first copied con­tent into a text edi­tor (like Notepad), Con­flu­ence fre­quent­ly changed the fonts or font sizes. Re-apply­ing a para­graph style with­in Con­flu­ence to the word or sen­tence did not fix the issue. For­tu­nate­ly, there’s a workaround.

Con­flu­ence Source Edi­tor is a free app that reveals the code on a giv­en page. If all else fails, you can strip out the extra code that is chang­ing the fonts. 


Using Con­flu­ence Source Edi­tor, I can hone in on a cer­tain word and strip out the code that sur­rounds the font. Here is an example:

By strip­ping out the span text, Con­flu­ence then dis­plays the text nor­mal­ly. As some pages can be rid­dled with this extra code, search­ing for and remov­ing it can quick­ly become tedious. 

My sug­ges­tion: Con­flu­ence should address these for­mat­ting issues so that tech­ni­cal authors do not need to fix con­tent this way. At the very least, this Source Edi­tor should be includ­ed in Con­flu­ence with­out hav­ing to search for and install the app.

Search and replace functionality

I worked for a client that rebrand­ed itself, mean­ing that its old name need­ed to be updat­ed on dozens and dozens of Con­flu­ence pages. For author­ing tools like Mad­Cap Flare, the search fea­ture can eas­i­ly comb through mul­ti­ple topics. 

Con­flu­ence includes a search and replace tool but it’s only for page by page. This means that some­one updat­ing the clien­t’s name needs to open the page, going to edit mode, find an instance of the old name, and replace it. This is a very time con­sum­ing process.

Con­flu­ence does offer apps that will per­mit you to search across mul­ti­ple pages with­in a space but they’re not free and you need to research, pay, and install the one that you’d like.

My sug­ges­tion: Atlass­ian, the com­pa­ny that makes Con­flu­ence, needs to include a free search and replace tool as part of its core prod­uct that can scan mul­ti­ple pages with­in a space.

Weak conditional text support

If you’ve used tools like Mad­Cap Flare, you under­stand the pow­er of con­di­tion­al text, which you allows you to sin­gle-source and include or exclude spe­cif­ic sets of infor­ma­tion. You can apply a con­di­tion to a char­ac­ter, word, sen­tence, para­graph, or entire sec­tions of content.

Con­flu­ence includes a form of con­di­tion­al text sup­port but it’s hard­ly robust. Using an app called Scroll Ver­sions, writ­ers can cre­ate dif­fer­ent ver­sions of con­tent and then asso­ciate the con­tent with a “vari­ant.” If you need to cre­ate three dif­fer­ent ver­sions of a para­graph, you can pub­lish three ver­sions using the Scroll Ver­sions app. The main chal­lenge with the app is that it forces users to pick which ver­sion they want to read using a drop­down in Con­flu­ence. Here’s an exam­ple in which a user might select among mul­ti­ple prod­uct versions:

My ver­dict: Although it’s bet­ter than noth­ing, Con­flu­ence’s sup­port is pret­ty weak com­pared to Mad­Cap Flare or oth­er tech­ni­cal writ­ing tools.

No built-in support for variables

In case you haven’t used vari­ables, here’s a def­i­n­i­tion from Mad­Cap’s online help: “Vari­ables are brief, non-for­mat­ted pieces of con­tent (such as the name of your company’s prod­uct or phone num­ber) that can be edit­ed in one place but used in many places…” If you need to update the vari­able, you only need to change it in one place and the change is auto­mat­i­cal­ly made every­where the vari­able appears.

Prod­uct names, cor­po­rate address­es, sup­port phone num­bers all tend to change from time to time. Using vari­ables makes a change super easy. There is an app called Easy Con­flu­ence Vari­ables that may pro­vide some of this func­tion­al­i­ty, although I haven’t had a chance to use it.

I like Con­flu­ence. But if tech­ni­cal writ­ers are going to embrace the tool, Atlass­ian needs to invest more effort in improv­ing it. Besides Con­flu­ence, are there oth­er wikis worth investigating?

Filed Under: Career Development, Help Authoring Tools, Online Writing, Professional Development, Robert Desprez | Vancouver technical writer | Blog Tagged With: Confluence, Madcap Flare, online writing, wikis

First impressions of MadCap’s purchase of IXIASOFT

March 8, 2023 by RDesprez 2 Comments

Mad­Cap Soft­ware’s pur­chase of IXIASOFT makes sense to me as it broad­ens Mad­Cap’s offerings.

I like Mad­Cap Flare and have rec­om­mend­ed it to a few clients over the years. While Flare already uses an XML-based archi­tec­ture, I have nev­er seen it used with Dar­win Infor­ma­tion Typ­ing Archi­tec­ture (DITA). By buy­ing Mon­tre­al-based IXIASOFT, Mad­Cap broad­ens its offerings—it now can sell a com­po­nent con­tent man­age­ment solu­tion that is based on the DITA standard.

It also shakes things up for Mad­Cap. I’ve heard from a few writ­ers and man­agers that Flare is start­ing to feel “dat­ed.” One client I worked with won­dered whether it should be offered as a soft­ware as a ser­vice (Saas). Even with reg­u­lar updates to the soft­ware, the first ver­sion of the soft­ware is more than 15 years old. One of Mad­Cap’s co-founders over­saw the devel­op­ment for Robo­Help, anoth­er help author­ing tool that start­ed in 1992. 

I would like to see a com­pa­ny like Mad­Cap fur­ther broad­en its soft­ware by offer­ing a superb wiki-based solu­tion that a team of writ­ers could use in an orga­ni­za­tion. Ide­al­ly, it would be a wiki devel­oped to han­dle com­plex tech­ni­cal documentation—with sup­port for con­di­tions, vari­ables, and snip­pets. In my opin­ion, it would stand out in the mar­ket­place. I recent­ly used Con­flu­ence again and was dis­ap­point­ed how lit­tle it seems to have evolved since I last used it years ago. 

In sum­ma­ry, I can see why Mad­Cap acquired IXIASOFT. Do you agree with my quick assess­ment? Are there oth­er author­ing tools you would like to see developed?

Filed Under: Help Authoring Tools, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: DITA, Madcap Flare, xiasoft

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

First Impressions of Adobe RoboHelp 2019

September 2, 2018 by RDesprez Leave a Comment

Adobe just released a new ver­sion of FrameMak­er and Robo­Help last month.  If you have used the appli­ca­tion for years, you might be for­giv­en for not even rec­og­niz­ing RoboHelp—it’s been com­plete­ly revamped.

First, for such an old pro­gram (more than 25 years!), Adobe has per­formed an “extreme makeover” when it comes to the user inter­face. It’s clean and mod­ern. It looks like a new application.

RoboHelp 2019 user interface

Adobe has bestowed Robo­Help with a min­i­mal­ist user inter­face. There are not dozens of icons to click like you see in an appli­ca­tion like Microsoft Word. Even though it looks dra­mat­i­cal­ly dif­fer­ent than old­er ver­sions of the pro­gram, I found myself being able to use it right away. How­ev­er, Adobe prob­a­bly rec­og­nized that not every­one wants to learn a new user inter­face so the com­pa­ny is also includ­ing Robo­Help Clas­sic 2019 for those users who pre­fer to work in famil­iar ways.

A Quick Way to Generate Output Files

I like the new way in which you can out­put files.

When you click the Quick Gen­er­ate icon, you can click the out­put you want to gen­er­ate. I like that you can cre­ate out­put files with­out a lot of con­fig­u­ra­tion. I also appre­ci­ate that you can keep work­ing while Robo­Help cre­ates the files in the back­ground. If you want to tweak set­tings for an out­put file, there’s still the Edit button.

Adobe Further Improves RoboHelp’s Search

Robo­Help 2019 builds on some of the improve­ments intro­duced in Robo­Help 2017. Most notably, Robo­Help 2017 includ­ed some wel­come improve­ments by dis­play­ing key­words as users type in the search field. For exam­ple, when I start typ­ing a search query about “con­tact­ing,” Robo­Help starts pro­vid­ing sug­ges­tions on the fly, sim­i­lar to Google’s search engine.

Robo­Help 2019 includes pre­dic­tive search but will also fix users’ typos.  For exam­ple, if I type “HTML5 out­pt,” the HTML5 Help auto­mat­i­cal­ly presents the cor­rect­ed results for me. Giv­en that many users may inad­ver­tent­ly add typos in their search queries, this is a wel­come addition.

RoboHelp 2019 Supports Git, HTML5, and Scalable Vector Graphics

Robo­Help also includes sup­port for Share­Point Online and Git, HTML5, Cas­cad­ing Style Sheets (CSS) 3, and Scal­able Vec­tor Graph­ics (SVG) images. Share­Point and Share­Point Online are not the same thing. With Share­Point Online, you can access inter­nal sites, doc­u­ments, and oth­er infor­ma­tion from anywhere—at the office, at home, or from a mobile device. Git is a ver­sion con­trol sys­tem for track­ing changes in com­put­er files and coor­di­nat­ing work on those files among mul­ti­ple people.

Over­all, I am impressed with the Adobe’s com­mit­ment to over­haul RoboHelp!

 

 

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

  • 1
  • 2
  • 3
  • …
  • 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

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