Category: Work

Over the past few months I’ve become much better at backing up the important stuff on my PC. Largely this is photos, music, any ripped DVDs and important House documents, license files and so on.

So, if my PC dies a death then at least I’ve got the important stuff backed up. The rest, the downloaded freebies, fonts, software and so on can be downloaded again and, in a way, it’s a chance to re-evaluate things.

Not that my PC is dying a death but it does, this very moment, have a virus. Not quite sure where it came from, as I’m very careful (having worked for an anti-virus company I remain somewhat paranoid about these things). All I know is that I was downloading an update to DirectX so I could have a go at Football Manager 2009 (a guilty pleasure if ever there was one), and as Microsoft downloads can be a bit flaky under Firefox, I fired up Internet Explorer (7) and kicked off the download.

Somewhere, somehow, I now have a virus. It’s proving a bugger to fix so I’m doing a little research to make sure I’ve got the right tools at my disposal. Such is the advantage of having a laptop. I can research the issue, download the right tools and fixes, dump them on a USB drive and I’m ready to tackle the virus.

It’s THIS kind of thing that just pisses me off. I don’t download illegal software, I virus check everything that I do download, even if it’s from a ‘safe’ source, and I have a good clean system which is checked for spyware, malware and viruses every 6-8 weeks. Then something like this happens and I just know I’ll spend a couple of hours fighting it.

That’s not why I have a computer. It’s not supposed to be a battle, it’s supposed to be a tool. Just like those arseholes who keep creating and releasing viruses. They’re a bunch of tools too.

(OK, mainly aiming at West of Scotland)

Following a recent discussion about ISTC local area groups, a few of us based in the West of Scotland have decided to try to set up a local group.

Our first meeting will be on Thursday 15th January 2009. If you work in the area (or further away), please come along to meet other writers and talk about technical writing.

We’ll meet at 7 p.m. in the offices of Sumerian in Glasgow city centre, at 19 Blythswood Square, Glasgow G2 4BG. Tea & coffee provided.

If you plan to come along, please email me so we can get a rough idea of how many writers might be attending:

gordon [DOT] mclean AT gmail [DOT ] com

(if you can figure out the email address you are allowed to attend 😉 )

Now, what on earth will we talk about??

My role in our company isn’t strictly defined so, outside of my work with the Publications team that I head up, I also get involved with other areas of the company either because I can help, or because there is a vested interest. That brought about the creation of our development community website and more recently has seen me involved in a company wide information project.

The main aims are to provide a consistent set of information to our customers, throughout their relationship with us. So from initial contact right the way through to rollout and future upgrades, we will have a coherent set of information that is updated accordingly and a clear idea of how it will all be communicated to the customer.

This is one of those ideas I’ve long had so it’s exciting to get something like this in place, agreed and set in motion. We are lucky in that we are still a small enough group that we tackle something like this without a huge amount of overhead, although obviously the main reason we are doing this is to help us be more successful.

The model itself is simple, with 4 layers of information:

1. Marketing Information
2. Business Sales Information
3. Technical Sales Information
4. Reference Information

In the real world the layers are not distinct, but by and large the model should help people understand what they should be writing, and what they can re-use across a variety of documents.

Naturally all of this will impact on the technical documentation, with many of the Business Sales level content helping us answer the question ‘Why would I want to use XYZ?’. It’s likely we will share a lot of information with the Technical Sales layer (architectural overviews and the like) but the bulk of work will remain the creation of reference information about our product and its capabilities.

We are still tweaking things, and will continue to do so into the New Year, but the very fact that we’ve started to adopt this approach is half the battle.

The war, of course, continues!

There are some fundamentals tenets of our profession that are widely accepted. One being that you always need to know your audience before y can begin to understand their needs and so produce the information that they require.

The reason I mention this is because, whilst it’s something very basic and is deeply grained in the technical writer part of my brain, I keep forgetting it.

Let me explain.

I’m currently working on a mini-project aimed at making sure the language we use and the things we talk about through all levels of our product information (from the website and marketing brochures, down to the lowest level of reference information) tell a consistent story. From basic facts and terminology to the concepts we need to convey, it’s important that everyone throughout our company talks about things the same way.

As such we’ve modelled the information into four layers with each layer (roughly) representing a broad layer of user and information types. These types match our engagement model and will allow other areas of the company to understand not only what information is required but, most importantly, WHO the information is for.

I’m writing up a summary document (covering two of the four layers) which will cover the main areas of the product and what language and terms we want to use. The document also outlines the basic concepts of our product, and for each concept describes the level of information expected. This will allow others to build specific documents at the appropriate level, focussed on the correct user type, using the correct language and terminology.

The trouble is that I’ve really been struggling to get my head around it and I was finding it very hard to write the descriptions for each conceptual area. I was mentioning this to a colleague earlier and that’s when it struck me.

I’d forgotten who I was writing for.

The summary document is aimed at internal staff, but is covering the information likely to be required by two different types of reader/layer. As I’ve been developing this information I’d lost sight of that and was trying to write one piece of information for two very different types of user.

So, I’ve decided to split the summary document into two, one for each type of reader and I’m already finding it much easier to structure the information accordingly.

I know I’m not alone when it comes to this kind of thing, that it’s very easy to become blinkered to everything else when you zero in on a particular task. I’ve been working fairly closely with a colleague on this but hadn’t spoken to her for a few days and, without that check in place, I’d started to lose sight of the big picture.

And yes, I know this isn’t rocket science, but hope it may serve as a timely reminder to others or at least let you learn from my mistakes.

If you get a moment go check out www.mclean.com or for that matter www.mclean.co.uk. I own neither unfortunately.

Both are high-level domains, both are classed as desirable (read, expensive) and both are currently being used… for nothing. Well I’m sure they bring in money for the person who owns them and has them sitting their forlornly with nothing but adverts on them.

It’s rather sad.

And very bloody annoying.

I pay for the domain names I have and I don’t mind doing so but having contacted the owners of these particularly domain names, domain names which obviously I might, maybe, be interested in using (dear first time reader, let me introduce myself, I’m Gordon McLean). Alas I’ve either heard nothing or the topic turnst to money and some rather large amounts are mentioned.

So, I’m setting up a blog appeal to raise sufficient fu…. no, I’m not really.

I just wanted to say that, you know, it’s annoying. My Mum and Dad have put HUGE amounts of effort into tracing our genealogy and where better to start putting the information than in the domain name for our family.

To be frank it just seems mean that these people are allowed to sit on these domain names and do nothing with them or than earn money for hosting adverts. Isn’t the internet supposed to be better than that?? They are the worst kind of leech and whilst I know that this blog post isn’t going to change their opinion (I’m sure they will point to the $xyz dollars they earn each year by sitting on those domains) it’s just a bit… crap.