one man writes
one man designs
one man blogs
one man tales

Archive of Information posts

 
 

What do you not do?



When was the last time you looked at the things you don’t do?

The reason I ask is that this very question is occupying my mind at the moment as I try to pull together both a content audit of what we have and a plan to create the things we don’t have. Which isn’t as easy as it may sound.

There are three or four different departments involved in the audit, and from each I’ve asked the same two things:

  1. A list of all the content you currently have
  2. A list of all the content you would like to have

With both lists in place, and understanding that some items in the first list may also need some rework or ongoing maintenance, we should all have a good view of what everyone else is doing and be able to plan a smarter way to produce more of the items in list two.

Whilst this is nothing radical it should help us by making people step back to see the big picture and allow us to move forward in one direction. Once this phase of the content audit is complete, the next stage, planning how to fill some of the “would like to have” gaps, will begin and once we start producing this content, regular catchups will help keep everyone up-to-speed and make sure we all focussed towards the same goals.

The tricky bit will be populating the second list. Asking your audience or colleagues for input will lead to one thing, a very big long list of “hey, do you know what would be REALLY good…” style requests. I’m more than happy to field those and they are, for the most part, good to have noted down.

Where it starts to get tricky is in the prioritisation of these things, and for that you’ll need to get some of the interested parties together to help. I’ve already covered how I do that but to make that process a bit slicker (it’s very ad-hoc at the moment) I’ll be setting up a common “Information Planning” meeting. That way we can involve the pertinent stakeholders in the decision process, and it will help communicate the ongoing plans around the Information Strategy.

Pulling it all together

Towards the end of last year I started to see how several related, but disparate, strands of work would start to come together. The information produced by my team, the training collateral, the partner focussed material, is all focussed on the product and this coming week will see the first step towards the realisation of all that hard work coming together into a cohesive story.

The final push comes in the form of a content audit, which will allow me to see where the gaps are, and where rework is required, to complete all the ’stories’ that run from the main product messaging, down through our information strategy pyramid.

At present we have successfully moved to a single source/content re-use system which allows us to publish content to a knowledge centre hosted on our developer community website, that content is also used by the sales/pre-sales department who receive it in a different format.

The developer community website will be used by partners to both learn and keep up to date with product developments, and reduce the burden on our Support team (something that is already happening with call numbers going down since we introduced our new knowledge centre). The website also means we can look at producing our forms of content for information delivery, videos, screencams, example tutorials and such like.

This is an area where the training team and publications team will come together and which the content audit will help drive.

On a personal note it’s nice to be on the final straight of some ideas I’ve had brewing for a couple of years now. I’ve been lucky that I work with a team of guys who I trust completely to do a good job and who’ve never let me down regardless of the challenge.

It’s going to be an exciting few months, with much to learn and many hurdles to be overcome but once complete I think we will have an excellent, information focussed culture throughout the company.

Buy-in for the information strategy will be re-enforced by the content audit as I’ll need to talk to everyone who could/should be involved, but it is noticeable that there has been a shift in understanding throughout our company with the realisation that information will play a larger and larger role in driving us forward.

Making the brave choices

I was recently asked to write an article about blogging for inclusion in a piece focussed on social media and how it will both challenge and change our profession as a whole and the more I wrote the more it helped me sort out my own thoughts on the matter.

One thing I’ve realised is that even if you don’t think social media will impact your own professional circumstances, I have no doubts that it will change the way our profession is perceived.

I’ve also come to realise that I’ve done a fair bit of talking about a lot of this stuff, yet continue to be stalled on actually doing it. So, with a new year stretching ahead of me I guess it’s time to put up or shut up.

As I have control of our developer community website the most obvious place to start is with a blog. Using the blog to publish short articles, and allowing people to comment on them seems to be a straightforward approach and with some encouragement I know some of the developers will contribute short articles as well.

The challenge will come in how we seed the community. At present it’s telling that with a little bit of PR, the number of people visiting the community website rises, so for now I’ll continue with the old school methods to drive traffic to the website (mainly through ‘update’ emails). Hopefully, if we provide enough interaction opportunities on the website, that need will drop away and the community well start to sustain itself.

Social media is a strange beast at times. There is always a lot of noise at first and, when it dies away it can seem like there isn’t much substance left. However, the people who are succeeding at using social media services, the people at the cutting edge of such things, the people who adopt new ideas and technology and are ready and willing to try them out to see if they work, are finding that there is a much richer set of capabilities than may be obvious, and the real value in your use of social media isn’t the technology but the people who use it, the community.

Your circumstances may mean that, for reasons outwith your control, social media just cannot be considered. However for everyone else, surely it’s time you took a step back and thought about the information you produce, the community of people who use it, and how best to meet their needs.

Maybe it’s time to make some brave choices.

And if you’ve come this far it’s about now that the reality of social media hits home.

You see for all the strengths and possibilities that the myriad of social media services offer, the one thing that no-one else can tell you is what choice to make. The direction you take depends on too many variables that only you know but, at this point, there is only one thing worse than making the wrong decision.

Not making a decision at all.

The information platform is changing, it is evolving and will continually evolve over the coming few years. You can’t afford to wait until the evolution is finished, you need to jump aboard now. You’ll need to learn fast, figure things out as you go, plan as best you can, and concede defeat at times but if you don’t then you’ll be left where you are now.

Except it’ll be 3 years further down the line and the rest of the world will have moved on.

Who cares if they read it or not?

RTFM

Seriously, do we spend too much time worrying about this? What do we get paid for after all, to write documentation, so that’s what we should concentrate on doing. So what if no-one reads it, as long as I’ve done my job I’ll get paid.

And no, I don’t care if they don’t understand how to use the product properly, if they choose not to read the documentation then there isn’t much more I can do, is there? Yeah, they might get stuck but if I can learn it, so can they. If not then maybe they shouldn’t

Pander, pander, pander. I’m sick of it. The documentation is perfectly good and until people learn to read it then they really should stop complaining. Ohh and if they choose to look on the internet for an answer to their question, good luck! We all know that those bloggering things are a lot of rubbish and no, I don’t use that Twatting thing either, what a waste of time. Don’t even start me on Facebooks.

I’m perfectly busy enough, doing the job I was paid for, so yes, they should RTFM and it’s not my fault if they don’t.

Obviously I’m jesting, but this seems to be a bit of a hot topic right now, and rather than rehash what has already been said, I’d highly recommend you spend 10 minutes of your day reading the following:

I guess it’s safe to say there are challenges ahead but hey, it’s a new year, what better time to start tackling them.

Information Strategy Pyramid

typing_monkey


The infinite monkey theorem states that a monkey hitting keys at random on a typewriter keyboard for an infinite amount of time will almost surely type a given text, such as the complete works of William Shakespeare. As such, it stands to reason that two monkeys would be able to produce the same volume of output, but are unlikely to write exactly the same thing. Add in a few more monkeys to the equation and suddenly you have lots of content, none of which really relates to anything else.

I’ll stop with the monkey metaphor before I insult anyone.

Consistency is an important part of communication, even at the simplest level of having a common terminology, using the same words consistently throughout a document helps the reader learn. Take this idea up a level, from a single document to a number of documents and maintaining the same terminology across all documents can further help re-enforce the messaging and aid learning, and should give the reader a level of comfort that the entire set of information has been thought of, and delivered, as a cohesive set.

Move up the stack one more time and you start to look around at surrounding areas of information, outside of product documentation, produced by a different department and it’s here that consistency starts to suffer.

Typically Technical Communications teams will spend some time developing their own Style Guide (however loose), and agree a basic set of terminology, also known as the Product Glossary. Having been involved with creating a Product Glossary in the past, it’s interesting that other areas of the company see it as being a ‘documentation thing’, until such times as you get them to sit down and help you compose entries for it.

I know that the information produced by my team will be consistent and is written in a similar enough style that it won’t ‘jar’ the reader. In other words, it doesn’t matter who wrote the information, it is all part of one larger set of documentation, with a similar tone, voice and style.

Aiming the information at the correct audience is a key part of deciding what the three attributes of tone, voice and style, should be, and it’s at this point that I find other departments starting to struggle. Without a clear idea of the audience, and with their own perception of what the message (the terminology) needs to be, there is a tendency to wander off message, and produce a document which, whilst perfectly good in isolation, doesn’t seem to fit into the overall set of product information.

So what type of information is this? Well it varies, and can be tracked through the customer (or company) journey and their interactions with your company and product. Broadly speaking there are four levels, all of which need to be talking to the correct audience, and ideally should be providing the same message in a consistent manner.

  1. First up there is an introduction, a high level chat about our product and what it can do. This is typically a mix of marketing brochures, website collateral, and sales presentations.
  2. The next level of interaction delves a little deeper into the business benefits and key selling points of the product, and can start to touch on product features and capabilities.
  3. After that, there is a need to provide a level of technical information, outlining the architecture and fundamental design of your product, detail the full set of capabilities, and provide reassurance around any potential implementation issues that may arise.
  4. And then we get to product documentation, training material, and ongoing support and maintenance information.

Four levels of information, all of which should be saying the same thing about the product, regardless of what message that is.

It would be wrong to say that each level is unique, as each interaction your company has with a customer will vary, but largely speaking the four levels allow anyone who is creating information to better understand their audience. Add in a Product Glossary to ensure terminology is consistent, and a strong product message and there is no reason why any of the content being produced cannot be consistent.

Mapping these levels to the amount of content available at each level gives us the following:

pyramid


Of course this is a very simplistic model, but as a starting point, it at least provides the mechanism for anyone about to create new content to pause and consider the audience. So whilst you could add in several levels, and several different mappings of document types, I think it’s better to leave things a little open to question as that helps bring a better understanding of why the content is being produced in the first place.

I first introduced this model to my current company several months ago, and we are currently revisiting this to make sure it is still a good fit to our needs. The next step for me is beefing up our Product Glossary, and then we can get on with the thornier issue of document management, an intrinsic part of having a Content Strategy for your company.

On taking notes

cu_home_taking_notes

I have been remiss at writing new content for this blog, and whilst this topic isn’t one that I said I’d post about (those posts are coming, I promise), it’s something I was discussing yesterday and so is at the forefront of my mind.

Like many people I still use pen and paper when taking notes, and regardless of the type of meeting I stick with three basic categories.

  1. [] Actions either for me or my team to do. Includes things that need done immediately or things which it would be good to do in the future.
  2. ? Questions on things I want to learn more about, which relate to my team. Whilst these may also be actions (typically they involve asking people questions) I differentiate them because, until I’ve asked the question, I don’t know enough to decide on whether there is anything to be done (caveat: if it is a burning issue, I’ll like put this against both categories ? [] ).
  3. I Information which covers all sorts of things from useful URLs, to quotes, to product names and so on.

I also “style” my notes, with the appropriate shorthand symbol first, then a gap, then the text for that item. Keeping that consistent makes it very easy to scan down my notes to process them.

[] email report to Fred
[] speak to Tina about next phase of work
? what is the cognitive learning project, who is running it?
[] write a blog post on the Information Strategy Pyramid
I stats for last week 103 open, 74 closed

Processing the notes, again, depends on the type of note.

For actions as, unless they can be done straight away (I think that is a GTD methodology thing? If it takes 1 minute to do it, and 1 minute to write it up and put it in a list, then you are better just doing it), they are transcribed into an online task manager application I use called Remember the Milk. It has a very nice iPhone app which makes it easy to “take my list” with me at all times.

Questions are simply a matter of being asked. That may drive further actions or information which are captured accordingly.

Anything I’ve noted down as information is either processed electronically, if it’s something online I’ll visit it and either bookmark it in my del.icio.us account, add it to my list on Instapaper (again, which has an excellent iPhone app), or grab it and store for later in Evernote (again, a useful iPhone app helps).

Whilst all of that seems like a lot of work, it’s very maintainable, and I spend less than 20 mins a day processing my notes. However it helps me keep on top of several different streams of work, and so far it hasn’t let me down. I’ve been using the shorthand symbols for a long time now, but obviously the electronic processing of these things is new.

So, what about you? How do you take notes? Are you a mindmapper? A random scribbler? Or do you, like one lady who attend a presentation I did a few years ago, do you draw out the subject and the notes in one go?

What next?

Last night, around 3am, I woke up. I lay there in bed wondering why I’d woken up and as my mind started to churn I realised I was very very awake.

In flooded four things I’ve been thinking about for some time, all of which are related but I couldn’t quite make the connection. Last night I cracked it. Maybe.

I’m still thinking it through but here are the four items in question:

  1. Single sourcing our documentation – and recent discussions with other areas of the company who could benefit from the same approach.
  2. Company Information Strategy – a simple pyramid based model that allows everyone creating content to ‘map’ their audience appropriately and which should start to help with consistency of terminology and messaging.
  3. Document Management – there have been some murmurings about this from a few people and it’s likely to fall into my lap.
  4. Requirements gathering – we’ve recently rolled out a new process which should lead to better requirements for each project build.

All of these are tied together, and if planned properly can feed off each other. Naturally there is quite a lot involved with all of the above and I’ll be revisiting items one and two in the coming weeks.

Ohh and I’ve still to pull together a slide deck on “selling our services”, which involves all of the above and more. Once it’s ready, I’ll share it here.

Exciting times ahead.