Robert Desprez Communications

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

Seven Ways to Improve the Technical Writing Review Process

October 10, 2018 by RDesprez 4 Comments

Writ­ing and prepar­ing tech­ni­cal con­tent for a review can be seam­less or stress­ful, depend­ing on dead­lines, the tools and tech­nol­o­gy, and the team per­son­al­i­ties and dynam­ics.  Here are sev­en ways to make tech­ni­cal reviews easier.

  1. Lim­it the num­ber of  Sub­ject Mat­ter Experts (SMEs) to four or five peo­ple. I recent­ly worked with a client who was attempt­ing to get 20 peo­ple with dis­parate views to agree to a doc­u­ment. If some of those peo­ple don’t like each oth­er or are not moti­vat­ed to get the work done, shep­herd­ing the doc­u­ment towards the “fin­ish line” is close to impossible.
  2. Use a col­lab­o­ra­tion tool like Share­Point or Con­flu­ence. Send­ing out reviews by email has its share of lim­i­ta­tions. One of the main weak­ness­es is that SMEs can­not eas­i­ly see each oth­er com­ments. When there are dif­fer­ences of opin­ion on a cer­tain para­graph or sen­tence, it can cre­ate more work for tech­ni­cal writ­ers as they may need to fol­low-up with mul­ti­ple SMEs to rec­on­cile the con­flict­ing edits. Tools like Share­Point and Con­flu­ence enable SMEs to review con­tent online and see all the oth­er comments.
  3. For con­tentious top­ics, arrange SMEs to sit in the same room. If you expect that your SMEs will have strong opin­ions about a giv­en sub­ject, arrange to have them sit in the same room and dis­cuss the con­tent. Try­ing to get con­sen­sus via e‑mail is hard­er than face-to-face meetings.
  4. Ask that SMEs focus on review­ing the accu­ra­cy of the con­tent. Remind SMEs that you want them to focus on the accu­ra­cy of the con­tent, not the pre­sen­ta­tion or for­mat­ting or writ­ing styles.
  5. Con­sid­er pro­vid­ing sug­ges­tions on the type of feed­back you’d like. I can­not tell you how many times I’ve seen SMEs high­light a sen­tence and write “???”. If some­thing is con­fus­ing or mis­lead­ing, encour­age SMEs to rewrite it.
  6. Set expec­ta­tions about how the review cycle works. Remind the client that the review cycle typ­i­cal­ly takes two to three iter­a­tions and that the con­tent doesn’t always need to be “per­fect.” The nice thing about doc­u­ments is con­tent can always be revised and improved for a future release.
  7. Con­sid­er using out­lines. If con­tent is com­pli­cat­ed or the mate­r­i­al is con­tentious, I’ve found it’s a lot eas­i­er to revise an out­line than to revamp or restruc­ture exist­ing content.

What strate­gies or tac­tics do you use to expe­dite or improve the tech­ni­cal com­mu­ni­ca­tion review process?

Filed Under: Robert Desprez | Vancouver technical writer | Blog Tagged With: SMEs, Subject Matter Experts, Technical Writing Review Process

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,187 242

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 ·
31 Oct 1984117857001807900

Image for twitter card

Meta, Google, and Microsoft Triple Down on AI Spending

Three of the biggest US tech companies reported record profits and record infrastructure spending on Wednesday, fuelin...

www.wired.com

Reply on Twitter 1984117857001807900 Retweet on Twitter 1984117857001807900 0 Like on Twitter 1984117857001807900 0 Twitter 1984117857001807900
robert_desprez avatar; Robert Desprez @robert_desprez ·
31 Oct 1984117264174739613

Reading The Coming Wave

Image for twitter card

The Coming Wave

An urgent warning of the unprecedented risks that AI and other fast-developing technologies pose to global order, an...

a.co

Reply on Twitter 1984117264174739613 Retweet on Twitter 1984117264174739613 0 Like on Twitter 1984117264174739613 0 Twitter 1984117264174739613
robert_desprez avatar; Robert Desprez @robert_desprez ·
28 Oct 1983003898656047193

Image for twitter card

Amazon to cut as many as 30,000 corporate jobs, reports say | CNN Business

Amazon is laying off as many as 30,000 corporate employees beginning tomorrow, reports say.

www.cnn.com

Reply on Twitter 1983003898656047193 Retweet on Twitter 1983003898656047193 0 Like on Twitter 1983003898656047193 0 Twitter 1983003898656047193
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 Oct 1973868879261938086

Image for twitter card

The magic of AI is giving way to complaints about workslop

A team from Better Up Labs and the Stanford Social Media Lab define workslop as ‘AI generated work content tha...

www.theglobeandmail.com

Reply on Twitter 1973868879261938086 Retweet on Twitter 1973868879261938086 0 Like on Twitter 1973868879261938086 0 Twitter 1973868879261938086
Load More

Recent Blog Posts

  • Using ChatGPT to read smarter
  • ChatGPT: The AI-powered proofreader
  • Four ways Confluence could be better
  • First impressions of MadCap’s purchase of IXIASOFT

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.