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

Five Reasons I Like Confluence

February 7, 2018 by RDesprez Leave a Comment

For tech­ni­cal writ­ers, there are a lot of rea­sons to like Con­flu­ence, a wiki soft­ware prod­uct that makes it easy to col­lab­o­rate across an enter­prise. Here are five rea­sons I enjoy using it.

Reason #1: Simplified User Interface

Con­flu­ence’s user inter­face is easy to use.  As the list of icons you see is so min­i­mal, you might think that Con­flu­ence isn’t a viable author­ing tool. But the beau­ty of Con­flu­ence is that Alt­lass­ian, the com­pa­ny who devel­ops the soft­ware, has hid­den away some of the more advanced func­tion­al­i­ty.  If you want to extend Confluence’s func­tion­al­i­ty even more, Alt­lass­ian includes more than 800 apps that you can add to the product.

Reason #2: Ease of Re-using Content

Con­flu­ence makes it easy to re-use blocks of con­tent using a two-step process.

First, using Con­flu­ence’s Excerpt macro, you enclose a block of con­tent (for exam­ple, a table) that you’d like to re-use.

The sec­ond step is decid­ing where the re-used con­tent will appear using Con­flu­ence’s Excerpt Include macro. You can have more than one Excerpt Include macro on a page, ref­er­enc­ing con­tent from mul­ti­ple locations.

Here are some more details on using the Excerpt macro: https://confluence.atlassian.com/conf59/excerpt-macro-792499102.html

Here is how to use the Excerpt Include macro: https://confluence.atlassian.com/conf59/excerpt-include-macro-792499101.html

Reason #3: Version Control and Automatic Track Changes

Con­flu­ence auto­mat­i­cal­ly tracks your edits and your Sub­ject Mat­ter Experts’ feed­back. Unlike some appli­ca­tions like Microsoft Word, Con­flu­ence auto­mat­i­cal­ly track changes behind the scenes. At any time, you can review the lat­est ver­sion of the con­tent and com­pare it against an ear­li­er draft.

To view a page’s his­to­ry and its list of edits:

1  Nav­i­gate to a page in Confluence.

2  Click … and click Page His­to­ry.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

Con­flu­ence dis­plays the his­to­ry of the page.
[expand  title=“See the fol­low­ing screen cap­ture”][/expand]
3  On the Page His­to­ry page, you can per­form one or more of the following:

a. Review an ear­li­er ver­sion of the page by click­ing an ear­li­er draft in the Ver­sion column.

b. Restore an old­er ver­sion of the page.

c. Com­pare two ver­sions of the page. Con­flu­ence will show what’s been added, delet­ed, or modified.

The one pro­vi­so about Confluence’s track changes fea­ture is it’s not as detailed as oth­er author­ing tools. For exam­ple, if you have mul­ti­ple Sub­ject Mat­ter Experts review­ing a giv­en page, it’s not obvi­ous who made which edit. In addi­tion, if you antic­i­pate that a page may need to be rewrit­ten, then you’ll be faced with a sea of edits. I find that Con­flu­ence’s Track Changes fea­ture works well if you expect light edits to con­tent you have drafted.

Reason #4: Built-in Support for Adding Flowcharts

Like many oth­ers, I am a big believ­er in includ­ing screen cap­tures or images to help clar­i­fy top­ics I am explaining.

One of the built-in macros is Gliffy, which makes it to easy to include flow­charts and oth­er types of dia­grams online. Here’s an excerpt of a flow­chart that I cre­at­ed in Gliffy.  It was sim­ple to cre­ate and edit.

Reason #5: Improve Your Authoring Experience with Apps

Con­flu­ence is pow­er­ful but you can eas­i­ly extend the prod­uct with more than 800 apps that cus­tomize and extend it using Atlas­sian’s Mar­ket­place.

For tech­ni­cal writ­ers, some use­ful apps include web ana­lyt­ics soft­ware that shows how many peo­ple are vis­it­ing cer­tain pages, how long they spend on each page, key­words that users type in Confluence’s search field, and on. I also cur­rent­ly use a source code app that helps me dis­play a page’s source code when Con­flu­ence does not for­mat con­tent as expect­ed. There are also search-and-replace apps that zero in on key­words and phras­es across mul­ti­ple pages instead of Confluence’s default page-by-page search tool.

Filed Under: Help Authoring Tools, Online Collaboration, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: Confluence, five reasons to like Confluence, technical writing, wikis

Managing Technical Documentation Review Cycles in Confluence

October 24, 2017 by RDesprez Leave a Comment

Con­flu­ence makes it easy for tech­ni­cal writ­ers to facil­i­tate reviews of their con­tent. In this blog post, I’ll address some of the dif­fer­ent ways you can solic­it feed­back from Sub­ject Mat­ter Experts using Confluence—by track­ing changes right on the Con­flu­ence page, by upload­ing a Microsoft Office file to Con­flu­ence, or by embed­ding a PDF file inside of a Con­flu­ence page.

What is Confluence?

Con­flu­ence is an online col­lab­o­ra­tion tool that allows peo­ple to cre­ate, share, and dis­cuss files, ideas, min­utes, and tech­ni­cal doc­u­men­ta­tion.  It also pro­vides spaces where con­tent cre­ators can cre­ate and orga­nize con­tent and discussions.

I like Con­flu­ence because it includes a sim­ple user inter­face but also con­tains fea­tures that make it eas­i­er for tech­ni­cal writ­ers to per­form their jobs.

Option 1: Tracking Changes in Confluence

When you write con­tent in Con­flu­ence, then invite one or more Sub­ject Mat­ter Experts to review and make edits to a page, Con­flu­ence auto­mat­i­cal­ly tracks the edits. At any time, you can review the lat­est ver­sion of the con­tent and com­pare it against an ear­li­er draft.

To review a page’s history:

1  Nav­i­gate to a page in Confluence.

2  Click … and click Page His­to­ry.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

Con­flu­ence dis­plays the his­to­ry of the page.
[expand  title=“See the fol­low­ing screen cap­ture”][/expand]

3  On the Page His­to­ry page, you can per­form one or more of the following:

a. Review an ear­li­er ver­sion of the page by click­ing an ear­li­er draft in the Ver­sion column.

b. Restore an old­er ver­sion of the page.

c. Com­pare two ver­sions of the page. Con­flu­ence will show what’s been added, delet­ed, or modified.

The one pro­vi­so about Confluence’s track changes fea­ture is it’s not as detailed as oth­er author­ing tools. For exam­ple, if you have mul­ti­ple Sub­ject Mat­ter Experts review­ing a giv­en page, it’s not obvi­ous who made which edit. In addi­tion, if you antic­i­pate that a page may need to be rewrit­ten, then you’ll be faced with a sea of edits. I find this option works well if you expect light edits to con­tent you have drafted.

Option 2: Adding a Microsoft Office File to Confluence

If you antic­i­pate a lot of changes, use Confluence’s file list fea­ture to add a Microsoft Office file to a page. The ben­e­fit of this approach is that you can use Microsoft Office’s Track Changes fea­ture.  All changes that you make to the Office file are auto­mat­i­cal­ly saved in Confluence.

To track changes by adding a Microsoft Office file to Confluence:

1  Open a Microsoft Office file that you want to upload to Confluence.

2  Make sure that Track Changes are select­ed with­in the Microsoft Office application.

3  In Con­flu­ence, click … beside the Cre­ate button.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

4  In the Cre­ate dia­log box, click Show more.

5 Click File list and click Cre­ate.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

6  In the Cre­ate file list dia­log box, add a name for your file list and click Cre­ate.

7  On the new file list page, upload the Microsoft Office file.

8  Once the file is uploaded, select the expand­able arrow beside the file.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

9  To edit the file, click Edit in Office.
    [expand  title=“See the fol­low­ing screen cap­ture”][/expand]

As the file shown in this exam­ple is a Microsoft Word file, Sub­ject Mat­ter Experts can open the file in Word and make their edits with Track Changes select­ed. After they are fin­ished edit­ing the file, the doc­u­ment is auto­mat­i­cal­ly uploaded to Con­flu­ence. This approach pro­vides Sub­ject Mat­ter Experts with a famil­iar way of working.

Option 3: Adding a PDF to a Confluence Page

Anoth­er way to man­age your reviews is by upload­ing a PDF file to a Con­flu­ence page. When a review­er clicks the PDF, Con­flu­ence opens a sec­ondary win­dow where Sub­ject Mat­ter Experts can review the doc­u­ment page by page. With­in the sec­ondary win­dow, Sub­ject Mat­ter Experts can also add com­ments through the document.

In the fol­low­ing exam­ple, I’ve com­ment­ed on my own doc­u­ment to illus­trate how the fea­ture works.
[expand  title=“See the fol­low­ing screen cap­ture”][/expand]

This may be a good option when you want Sub­ject Mat­ter Experts to review your draft with­out actu­al­ly mak­ing edits to the source con­tent. On the oth­er hand, if get­ting feed­back quick­ly is an issue, this may not be the best option because you then need to incor­po­rate your edits into the source files.

From past expe­ri­ence, I’ve also heard review­ers com­plain about this sec­ondary win­dow as it can be a lit­tle unpre­dictable (for exam­ple, clos­ing unex­pect­ed­ly). It also does not allow users to search for words or phras­es, unlike Adobe Acro­bat Read­er or Adobe Acro­bat Professional.

Con­flu­ence offers mul­ti­ple ways for you to gath­er feed­back from Sub­ject Mat­ter Experts.

Filed Under: Help Authoring Tools, Online Reading, Online Writing, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: Confluence, Subject Matter Experts, Technical Writing Reviews

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 238

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.