Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me
You are here: Home / Online Collaboration / MARRYING TWITTER WITH USER DOCUMENTATION

MARRYING TWITTER WITH USER DOCUMENTATION

March 18, 2011 by RDesprez 11 Comments

Tweet

I just got back from the Writ­er­sUA tech­ni­cal writ­ing con­fer­ence yes­ter­day in Long Beach, Cal­i­for­nia. As I expect­ed, I attend­ed many real­ly inter­est­ing sessions.

Here’s one great idea. Sarah Mad­dox, an Aus­tralian tech­ni­cal writer, works at Atlass­ian, the com­pa­ny that devel­ops JIRA (bug and issue track­ing soft­ware) and Con­flu­ence (web-based cor­po­rate wiki soft­ware). She and her team cre­at­ed wiki doc­u­men­ta­tion that com­bines tra­di­tion­al tech­ni­cal doc­u­men­ta­tion, social media, and links to relat­ed blog posts. Here’s a screen capture:

 

This screen cap­ture shows a sam­ple of Atlassian’s wiki doc­u­men­ta­tion, which includes a Twit­ter stream at the bot­tom of the page.

If users tweet on a giv­en top­ic, they’re reward­ed by giv­en an online badge that they can add to their own blogs or social sites.

Sarah and her col­leagues at Atlass­ian have pulled off a rare feat—content that mar­ries tech­ni­cal doc­u­men­ta­tion, social media, and even viral mar­ket­ing. Because users who decide to tweet are offered an online badge, oth­ers might see the badge on anoth­er site and then tweet as well, which could lead to more and more users con­tribut­ing to the dia­log via Twitter.

This project won the most inno­v­a­tive idea at the Writ­er­sUA “peer show­case.” I think it’s a great idea and well deserved.

Filed Under: Online Collaboration, Robert Desprez | Vancouver technical writer | Blog, Social Media, Web 2.0 Tagged With: online documentation, social media, Twitter

Comments

  1. Sarah Maddox says

    March 17, 2012 at 5:01 pm

    Hal­lo Robert
    Thanks so much for blog­ging about my pre­sen­ta­tion at Writ­er­sUA. What a great con­fer­ence it was! So many great peo­ple and so many ideas to chew over until next time. 🙂
    Cheers
    Sarah

    Reply
  2. Sarah Maddox says

    March 17, 2012 at 5:01 pm

    Hal­lo Robert
    Me again. Are you plan­ning to blog about your Writ­er­sUA pre­sen­ta­tion on web ana­lyt­ics? I missed it at the con­fer­ence, because they had 5 ses­sions hap­pen­ing in each time slot. I’d love to read all about it. 🙂
    Cheers
    Sarah

    Reply
  3. Robert Desprez says

    March 17, 2012 at 5:01 pm

    Hi Sarah,

    Sure, I’d aim to write a sum­ma­ry about my pre­sen­ta­tion in the next week or two.

    Reply
  4. Malgorzata Karwasz-Jarosik says

    March 17, 2012 at 5:02 pm

    It may be a great tool that accel­er­ates the process of cre­at­ing doc­u­ments by the means of instant co-oper­a­tion with SMEs. I’d love to try it.

    Reply
  5. Neeraj Jain (LION) says

    March 17, 2012 at 5:02 pm

    I must say that you attend­ed a won­der­ful session 🙂 

    If we were to con­sid­er pop­u­lar­i­ty of Twit­ter and how fast it works, merg­ing is a great idea. I feel that this will lead to con­ver­gence of help akin to con­ver­gence of tech­nol­o­gy. There are some orga­ni­za­tions which block access to net­work­ing sites. There it could be an issue.

    Reply
  6. Adam Evans says

    March 17, 2012 at 5:02 pm

    I’ve been brain­storm­ing ways to imple­ment our wiki-based doc­u­men­ta­tion with social media, and this is a great idea. Would love to hear more.

    Reply
  7. Robert Desprez says

    March 17, 2012 at 5:03 pm

    Hi Adam,

    I’m sure Sarah Mad­dox, the writer who cre­at­ed the doc­u­men­ta­tion, could give you some addi­tion­al sug­ges­tions on how to imple­ment it. Her blog: http://ffeathers.wordpress.com/

    Reply
  8. Neil Perlin says

    March 17, 2012 at 5:03 pm

    Hi Robert — I like the idea. Would you mind if I ref­er­enced your blog in a tweet? Neil Perlin

    Reply
  9. Kevin B says

    March 17, 2012 at 5:04 pm

    That does sound like a great idea. What was the result? Did it reduce sup­port costs? Or was that not the goal?
    I could­n’t tell from the slides (post­ed on the ffeath­ers site).

    Reply
  10. Robert Desprez says

    March 17, 2012 at 5:04 pm

    Hi Neil,

    No prob­lem. Go ahead and ref­er­ence my blog.

    Thanks for asking.

    Reply
  11. Robert Desprez says

    March 17, 2012 at 5:04 pm

    Hi Kevin,

    Sarah did­n’t men­tion if sup­port calls dropped. I’d fol­low up with her via her web site.

    Thanks for your post.

    Reply

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

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,184 239

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 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
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 Oct 1973599012268941339

What a great website to book a BC ferry, if they are reserved. I just bought Vedran B a coffee on @buymeacoffee! 🎉

You can support them here —

Image for twitter card

Vedran B

I created https://nextsailing.ca as a free tool to help locals from the Lower Mainland and Vancouver Island book t...

buymeacoffee.com

Reply on Twitter 1973599012268941339 Retweet on Twitter 1973599012268941339 0 Like on Twitter 1973599012268941339 0 Twitter 1973599012268941339
robert_desprez avatar; Robert Desprez @robert_desprez ·
27 Sep 1972079492962439576

Image for twitter card

Opinion: Big Tech’s flattery of Trump is getting them nowhere

With the new price tag on H-1B visas, tech companies are learning that currying favour with Trump is a losing game

www.theglobeandmail.com

Reply on Twitter 1972079492962439576 Retweet on Twitter 1972079492962439576 0 Like on Twitter 1972079492962439576 0 Twitter 1972079492962439576
robert_desprez avatar; Robert Desprez @robert_desprez ·
23 Sep 1970576226126541085

Image for twitter card

Is AI the learning tool of the future, or should we be worried about its use in higher education?

Many students are already using AI to conduct research, summarize readings and write essays. On Machines Like Us, ...

www.theglobeandmail.com

Reply on Twitter 1970576226126541085 Retweet on Twitter 1970576226126541085 0 Like on Twitter 1970576226126541085 0 Twitter 1970576226126541085
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.