Robert Desprez Communications

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

ChatGPT: The AI-Powered Proofreader

August 28, 2023 by RDesprez Leave a Comment

Chat­G­PT, a text-gen­er­at­ing mod­el devel­oped by Ope­nAI to sim­u­late respons­es that resem­ble human con­ver­sa­tions, saves you time and effort by edit­ing your documents.

Copy a page of con­tent into Chat­G­PT and request that it sum­ma­rize the infor­ma­tion. In sec­onds, it sum­ma­rizes the mate­r­i­al before your eyes—much faster than any human that I know.

For a tool that is just emerg­ing, it is sur­pris­ing­ly ver­sa­tile. You can ask it for help with pro­gram­ming, brain­storm­ing, writ­ing head­lines (Chat­G­PT sug­gest­ed the head­line for this blog post), trans­la­tions, mar­ket­ing mate­r­i­al, and plan­ning a trip.

A quick simple test

I decid­ed to give it a test. I copied an ear­li­er blog that I draft­ed about Mad­Cap Flare and delib­er­ate­ly added errors (high­light­ed in red) to the text. In my state­ment to Chat­G­PT, oth­er­wise known as a prompt, I wrote, “Check the fol­low­ing con­tent for incon­sis­tent acronyms, con­sis­tent spelling of com­pa­ny names, gram­mar and typos, and make sure all num­bers under 10 are spelled out.” 

In under 10 sec­onds, the AI tool gen­er­at­ed a new ver­sion of the con­tent and sum­ma­rized the edits made:

Chat­G­PT quick­ly caught all the errors and even cor­rect­ed the case of “Robo­Help,” which is the offi­cial name of the help author­ing tool.

Purge passive voice using ChatGPT

Many tech­ni­cal writ­ing depart­ments fer­ret out exam­ples of pas­sive voice and strive to re-write the con­tent so it is active because the writ­ing is more suc­cinct and eas­i­er to under­stand (of course, there is a place for pas­sive voice). In the fol­low­ing exam­ple, I asked Chat­G­PT to revise the fol­low­ing sen­tences that use pas­sive voice:

In moments, Chat­G­PT revised the sen­tences so they were active:

ChatGPT does have limitations

The AI tool does have its limitations:

  • Lacks under­stand­ing: If you write a tech­ni­cal report about a mine or a pro­pri­etary soft­ware pack­age, it will not under­stand the details of the con­tent. Sub­ject Mat­ter Experts must still vet the accu­ra­cy of the content.
  • Good prompts are required: Typ­ing vague com­ments like “edit this doc­u­ment” and the tool may not edit what you require. If you want to check a doc­u­ment for pas­sive voice, include the specifics of what you need.
  • Chat­G­PT was last updat­ed in 2021: If you require cur­rent infor­ma­tion about a major world event last year (such as Rus­sian’s inva­sion of Ukraine), Chat­G­PT will be “in the dark.”
  • Be care­ful of con­fi­den­tial­i­ty. See Gen­er­a­tive AI Chat­G­PT Can Dis­turbing­ly Gob­ble Up Your Pri­vate And Con­fi­den­tial Data, Fore­warns AI Ethics And AI Law

Still, it is sur­pris­ing­ly pow­er­ful and fast tool that can help with writ­ing and edit­ing. Check out ChatGPT. 

Filed Under: Career Development, Professional Development, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: chatgpt, editing, technology

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

Online Conferences for Technical Writers in 2023

March 7, 2023 by RDesprez Leave a Comment

Here is a list of inter­est­ing in-per­son and vir­tu­al con­fer­ences for tech­ni­cal writ­ers in 2023:

Write the Docs, May 7 to 9, 2023, Port­land, Ore­gon
Write the Docs

Women in Tech Glob­al Con­fer­ence, May 9 to 11, 2023
Women in Tech

STC annu­al con­fer­ence, May 14 to 17, 2023, Atlanta, Geor­gia
http://summit.stc.org/

Evo­lu­tion of TC, June 6 to 7, 2023
Evo­lu­tion of TC 2023

Write the Docs Atlantic 2023, Sep­tem­ber 10 to 12, 2023, online
Write the Docs

Mad­World Con­fer­ence, Octo­ber 8 to 11, 2023, San Diego, Cal­i­for­nia and online ver­sion
Mad­World

Lava­con, Octo­ber 14 to 17, 2023, San Diego, Cal­i­for­nia
http://lavacon.org

Write the Docs Aus­tralia (details to be announced)

Filed Under: Career Development, Professional Development, Robert Desprez | Vancouver technical writer | Blog

How Checklists Can Make Your Job Easier

February 27, 2022 by RDesprez Leave a Comment

As a tech­ni­cal writer who relies on check­lists for aspects of my work, I just had to read a book called The Check­list Manifesto.

Atul Gawande, the author of the book and a sur­geon and a pro­fes­sor at Har­vard Med­ical School, argues that check­lists are essen­tial in all facets of society—from deliv­er­ing qual­i­ty health care, to design­ing and con­struct­ing build­ings, to research­ing what invest­ments to buy, to assist­ing pilots to han­dle emer­gen­cies, such as engine fail­ures. Gawande says the rea­son that mis­takes occur is due to the vol­ume of infor­ma­tion and increased com­plex­i­ty in so many aspects of soci­ety. Despite the addi­tion­al train­ing that is required in so many jobs and an abun­dance of tech­nol­o­gy, we still often fail to deliv­er the intend­ed results.

Check­lists can mit­i­gate some of these mis­takes. One exam­ple he includes is how a sim­ple check­list can help over­whelmed med­ical pro­fes­sion­als go over some of the basics before oper­at­ing on patients. Before surgery, doc­tors are sup­posed to per­form the following:

  1. Wash their hands with soap.
  2. Clean the patien­t’s skin with an antiseptic. 
  3. Put ster­ile drapes over the entire patient.
  4. Wear a mask, hat and ster­ile gown.
  5. Put a ster­ile dress­ing over the inser­tion site of the “cen­tral line,” a catheter placed in a large vein in the neck, chest, groin, or arm. 

Gawande acknowl­edges these steps are con­sid­ered “no-brain­ers.” But in one study, doc­tors for­got to per­form at least one of pre­vi­ous steps more than 30 per­cent of the time.

I think check­lists can be invalu­able for cer­tain aspects of tech­ni­cal writ­ing. In my cur­rent con­tract, cre­at­ing a check­list helps me iden­ti­fy and fix the com­mon for­mat­ting areas in more than 40 local­ized doc­u­ments. Are the trans­lat­ed notes and warn­ings in a doc­u­ment dis­play­ing prop­er­ly? Are the local­ized cross-ref­er­ences appear­ing as intend­ed? Are the French screen cap­tures dis­play­ing prop­er­ly? Each local­ized doc­u­ment, which can run from 150 to 1,000 pages, may con­tain a hand­ful of prob­lems that need to be fixed. In short, the hum­ble check­list helps me fix the prob­lems before I send it for an inter­nal review.

Yet, despite the use­ful­ness of check­lists, Gawande notes that peo­ple may be reluc­tant to use them. He writes:

“We don’t like check­lists. They can be painstak­ing. They’re not much fun. But I don’t think the issue here is mere lazi­ness. There’s some­thing deep­er, more vis­cer­al going on when peo­ple walk away not only from sav­ing lives but from mak­ing mon­ey. It some­how feels beneath us to use a check­list, an embar­rass­ment. It runs counter to deeply held beliefs about how the tru­ly great among us—those we aspire to be—handle sit­u­a­tions of high stakes and com­plex­i­ty. The tru­ly great are dar­ing. They impro­vise. They do not have pro­to­cols and check­lists. Maybe our idea of hero­ism needs updating.”

Gawande’s quote res­onat­ed with me because I have occa­sion­al­ly come across writ­ers who are reluc­tant to use them. Maybe they con­sid­er the check­list to be too sim­ple? Per­haps they feel it’s an affront to their knowl­edge? Oth­ers prob­a­bly don’t want to go to the effort of cre­at­ing or fol­low­ing one. What­ev­er the rea­son, I feel that check­lists can be indis­pens­able when you have a large vol­ume of work that con­tains spe­cif­ic tasks that needs to checked.

Filed Under: Career Development, Professional Development, Robert Desprez | Vancouver technical writer | Blog Tagged With: career development, localizations, professional development, translations

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