Help write a Twitter guide for technical communicators

Would you like to help write a guide to using Twitter, especially for technical writers? At the same time, you can try out Confluence wiki and learn from other tech comm Twitter experts.

An interesting fact: The top post on this blog is a technical guide to prepopulating tweets and embedding tweets in a document. (Here’s the post.) It has received more than 13 thousand visits to date. The next most popular post, about writing REST API documentation, has received 11 thousand visits and has been around for two years longer than the Twitter post.

People really want to know about this stuff. We can use Twitter in our documentation, in our careers, and in communication with our peers. How great would it be if we had a technical communicator’s guide to Twitter, written and regularly updated by us!

That idea came to me while I was writing my book, Confluence, Tech Comm, Chocolate: A wiki as platform extraordinaire for technical communication. Then I took the idea a step further and made the writing of the guide a project that Ganache, the hero of the book, was tackling. Ganache wrote part of the guide. The screenshots are in the book. She also wrote some stubs for pages that she thought would be useful in the guide.

Now it’s up to us to complete the guide, and to keep it up to date.

How to contribute to the Twitter guide for technical communicators

Go to the wiki, at, and follow the instructions to get a username. It’s free, and you can choose any username that hasn’t yet been taken. You will need to give an email address, but the email address won’t be shown to other users (unless you make your username the same as your email address).

Read the Twitter guide, and fill in the missing details. All contributions welcome. You can edit the existing pages or add new ones. Other people will probably edit your pages too. It’s a wiki, and all logged-in users have permission to update the pages. Content is licensed under a Creative Commons copyright, as specified in the footer of each page.

Who else is on the wiki?

Your name will appear along with the others who are already there. I’m there, and so is Ganache.  🙂

Wiki-Wiki Shuttle

I’ve just spent a couple of days on the island of Oahu, in Hawaii, on my way to and from the STC Summit 2012. I couldn’t resist taking this snap:

About Sarah Maddox

Technical writer, author and blogger in Sydney

Posted on 3 June 2012, in book, confluence tech comm chocolate, technical writing, wiki and tagged , , , , , , . Bookmark the permalink. 5 Comments.

  1. Hello,

    technical platform to enhance most individuals, and mature all together – GREAT proposal!
    Thank you,
    Will try my first wiki 🙂

  2. I’d like to help out and I’ll read the wiki this evening/ I recently wrote a quick guide to using Twitter on my blog:

    • Hallo Roger

      That’s a great post. I love the diagrams you’ve used. It will be great to have your input to the Twitter guide on the wiki.

      A suggestion: You could add a new page to the wiki, for references and further reading, and add a link to your post. I’m sure other people would like to add links to the page too.

      See you on the wiki. 🙂

      Cheers, Sarah

  1. Pingback: A Technical Communicator’s Guide to Twitter | STC Atlanta - Society for Technical Communication

Leave a Reply

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

You are commenting using your 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 )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: