Posts tagged ‘Twitter’

Using social networking for documentation

I have recently been reading a fair bit about how social networks are being used for technical communication. It’s a hot topic, and although some companies’ tech writing teams are already joining in conversations with users on Facebook, LinkedIn and their own user forums, how they include this kind of content in their documentation is what they are currently trying to get their heads around.

You may have already heard the term “Web 2.0” thrown around. It is the term that has been associated with websites that allow users to interact and collaborate with each other in a social media kind of dialogue. Or as Wikipedia so clearly puts it, “Web 2.0 is associated with web applications that facilitate participatory information sharing, interoperability, user-centered design, and collaboration on the World Wide Web.” Right…

From personal experience, this type of communication and user-influenced documentation has been seen in the online gaming world for some time.

Customer service-wise when players need help, they go to the game’s official website forums to ask the question. Then, more often than not, it is the other players that answer the question before any of the official game developers get a chance to. This happens regardless of how good the how-to documentation is. I think the thought process is along the lines of “why spend time researching when I can just ask?”

Additionally, as time goes by, these forums begin to replace the how-to documentation. The sea of discussion threads will appear very messy at first, but there will be a search function to tidy it up. Using keywords, you can filter discussions to often find exactly what you are after. And not only that, you can read an entire conversation that has already taken place about the issue or feature. If the conversations are too dated, that is when you may have to refer to the almost redundant how-to documentation. Or alternatively, you could start a new discussion…

Here are some examples I have come across recently of this growing Web 2.0 trend:

Writing procedures in Facebook

2morodocs talks about this very interesting concept. Some of the main advantages I gleaned from this were:
• Format – the Facebook layout bodes well for procedure writing
• Updates/changes – if your product is evolving, you can ensure everyone knows how and why as soon as it does.
• Customer service – as well as being able to provide real-time support (procedures are easy to write), by providing hints and tips you can also provide people with information they need, before they even know they need it.
• Relevance – by including regular features, you keep your product fresh and in peoples’ minds.

Hosting documentation in a wiki
There are two types of wiki, open and closed. Open wikis allow anyone to submit content, most famously demonstrated by Wikipedia, while closed ones only allow employees or specified users to add content. An open wiki can present problems, which mainly stem from managing and hosting the “crowd-sourced” content. Wikipedia does this by keeping the entire website level (there is no hierarchy or website architecture), but hosting business documentation this way is another matter. This is why the majority of businesses using a wiki for documentation (or thinking about doing so) are using a closed version.

I did find an example of an open wiki however, which uses a wiki called Confluence (there are numerous wikis that have been developed – i.e. Wikipedia uses MediaWiki). The company, Atlassian, developed the wiki themselves and this example is the wiki for their software application CROWD:

Including tips via Twitter
Websites can contain a text box that displays a continuously-updated list of tweets. It will recognise recent tweets containing a predefined word and display them. Anyone can write a tip and have it show on the page, which, when added to the homepage of a documentation website, gives it that freshly updated feel.
I found a good example of this while browsing Atlassian’s wikis. Their JIRA wiki has one:

Living documents – getting users involved
Sarah Maddox, a technical writer for Atlassian, gave a presentation recently at the WritersUA 2011 conference. Considering the work they are doing in this social networking field at Atlassian, I thought a link to the run down of what she said might be appropriate:

“At Atlassian, we’ve been using social media in various ways, to make our documentation a living, interactive hub where people can find the answers to their questions, talk to us, talk to each other, and use the documentation as a tool to help each other.”


May 23, 2011 at 9:11 am 2 comments

Shorten those words! Or just spell them wrong…

Mobile phones started it, online chat continued it, Facebook made it mainstream and Twitter took it to a whole new level. Bashing the English language has become the norm. If you use proper grammar and spell everything out in full nowadays, you’re the weird one!

There’s the common conception that there is a language called “txt speak”. And there is, but not as you know it. Generation Z (are we up to that yet?) use words like ‘lol’ as part of their everyday language… out loud. You’re not up with the play any more if you simply know what OMG stands for. “Txt speak”, if we have to put a label on it, is a continually developing language, and it’s Twitter that is adding the most recent touches to it.

I’m not talking about Twitter’s own language either, that’s another story altogether. In fact, I was recently on and learnt a few things for myself! Aside from the fact that you can add ‘Tw’ to the start of any word to add Twitter to its definition (I think the most amusing one I found was ‘Twurch’, which means providing sermons and scripture over Twitter), there were numerous new acronyms and a plethora of new words. And the prerequisite for word creation seems to be as simple as celebrities using it. Then if it starts getting RTd (re-tweeted) on a regular basis, it’s a word.

Twitter has also normalised the shortening of words like never before. It did start with txting, but not everyone picked up on it. And saying as much as possible while using as few characters as possible couldn’t be more important than when you’re Twittering – y wld u typ 4 ages whn u cn gt ur msg in 1 line?

If you want to remain fluent in “txt speak”, ensure you know the following so you aren’t lost from the word go:

• ICYMI – in case you missed it

• JSYK – just so you know

• IIRC – if I recall correctly

• IMHO – in my humble opinion

• DYK – did you know

• FTR – for the record

And the same applies to signing off. If someone ends a txt, Facebook or Twitter message with HAND, don’t look puzzled, they’re actually being nice. It means “have a nice day”.

What do you think of txt speak? Have you heard any interesting new words or acronyms lately? What do you think of people using the acronyms as part of everyday spoken conversation?


May 3, 2011 at 9:16 pm 6 comments

Information Mapping Partner

Recent Posts

Enter your email address to subscribe to this blog and receive notifications of new posts by email.

Join 16 other followers