Badges for Twitter tips and thanks to technical writers

It’s recently struck me again: There is so much creativity, generosity and enthusiasm in the technical writing community! A while ago, I let people know that I was kicking off a project called Tips via Twitter. Many technical writers commented and tweeted their encouragement and ideas. Now we’ve just started a Twitter tips stream for another of our products, and designed badges that tweeters can display on their blogs.

The badges are oh so cute. Vijayendra Darode came up with the idea and posted a comment on my earlier blog post:

To encourage users to tweet tips, I would consider giving them a badge of honour which they can proudly display on their blogs or any social networking site. A badge which says “I share my Tips via Twitter. Do you?” or something similar.

Thank you so much Jay! Here’s what the badges look like:

Badges for Twitter tips and thanks to tech writers Badges for Twitter tips and thanks to tech writers

(If you want one for your blog, grab the HTML from my Atlassian blog post.)

Highlighting the fact that people can contribute to the documentation

Larry Kunz had another great idea, that we should make the community aspects of our documentation more visible. So I’ve been creating pages called “Contributing to the xxx documentation”, where “xxx” is the product name. For example, here’s the page for our JIRA bug tracker: Contributing to the JIRA documentation, and for the Confluence wiki: Contributing to the Confluence documentation.

The “Tips via Twitter” pages are now children of those pages, and so are the “Tips of the Trade” pages, where we link out to “how to” blog posts by our customers and community.

What’s more, we now have a shiny new button in the page footers, directing people to the page about contributing to the documentation:

Badges for Twitter tips and thanks to technical writers

Thank you to the technical writing community

Innovation, passion and generosity are alive and well amongst technical writers. Thank you everyone! I’ve also added a paragraph in the Atlassian blog post, letting people know that the technical writing community rocks!

About Sarah Maddox

Technical writer, author and blogger in Sydney

Posted on 14 August 2010, in Confluence, technical writing and tagged , , , , , , , , , , , , , . Bookmark the permalink. 3 Comments.

  1. What wonderful ideas! It’s an excellent way to encourage participation and use of social media. There’s so much potential with Twitter. It’s nice to see this unique approach to push the envelope a bit.

  2. Great ideas! Please do a follow-up post after a while to let us know how they affect actual participation.

  1. Pingback: Tweets that mention Badges for Twitter tips and thanks to technical writers « ffeathers — a technical writer’s blog -- Topsy.com

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: