one man writes
one man designs
one man blogs

Archive for November 2007

 
 

Recently Read

With the TICAD conference last week, a couple of days in my sick bed, and the imminent product release I’m working towards, I’ve not had a lot of time to post here. However, the RSS feeds keep trickling in, so here are a few items that caught my eye over the past couple of weeks.

What Beautiful HTML Code Looks Like
I’m a terrible coder. Which is just as well because I’m not a developer but as I do dabble in HTML and CSS quite frequently (hey, and PHP too), then this is a good reminder for me to develop my own best practises.

Code is Tabbed into Sections: If each section of code is tabbed in once, the structure of the code is much more understandable. Code that is all left-justified is horrific to read and understand.

Includes a neat infographic, downloadable as PDF, which is now pinned beside my desk.

Procedures: The Sacred Cow Blocking the Road
An update on a (yipes) 10 year old article. I don’t think I read it when it was first published but I have read it. Well worth another visit though.

“It takes a surprisingly short amount of time for a user to feel unstuck. When I was a usability consultant, I used to advise clients to put the critical information in the first three words of a sentence.”

IA Deliverables
From Content Surveys, to wireframes, Personas and Use Cases, a brief overview of each is followed by a sample template. Not only a useful resource but a good overview of the typical process an Information Architect will undertake, a lot of which can be adapted to more traditional product documentation.

Collaboration is not a dirty word
Collaboration on content (not documents, even if that is where the content ends up) was a key part of my presentation. It’s good to see the switch from document-centric to info-centric taking place.

I love things being this easy. I love getting (almost) zero emails with attachments. I love not having a hard drive full of Word documents.

DITA Troubleshooting specialization

The Troubleshooting specialization creates a new topic type that is well-suited for problem-solution information.

7 Ways to keep the post-conference buzz
Not long back from a conference myself, I have already done a few of these things (item 3 in particular) but some good ideas here.

Wikis for Documentation?
Steve Manning isn’t sure about using Wikis for Documentation but does think they could be a big hit in another, related area:

Most writers have to guess about their users. Few writers get the opportunity to speak directly with users. Few get any sort of feedback at all. They are left to do their best. How useful would it be to be able to post your document on a Wiki and have users be able to comment topic-by-topic? To see the questions they ask?

I totally agree. All I need to do is figure out how this works within a single source environment, and tackle a few issues around governance and change management and it could be an excellent working model.

And finally…
I’ll be updating the TechComms RSS feeds download soon, so if you think you should be on the list (or even if you aren’t sure whether you are or not) then let me know. It includes all kinds of stuff which is loosely related to Technical Communications, and I’m always on the lookout for more sources of inspiration. Leave a comment if you think of anything.

Dilbert does it again (again)

(What are the odds? If he smashes the nail on the head again tomorrow I WON’T post it here, I promise)

I really don’t know how Scott Adams manages to tap into these things, or is the software industry REALLY that similar the world over?

As the discussion of what we call ourselves, how much we should earn, what we do, why and what we need to justify, and why few seem to really GET what we can offer to a company (but that last one is kinda our fault), continues to rage across two mailing lists, this seems timely:

(click for bigger)

Dilbert does it again

I really don’t know how Scott Adams manages to tap into these things, or is the software industry REALLY that similar the world over?

Regardless suffice to say that, in our Extreme Programming (XP) development group (XP is a form of Agile development), todays’ Dilbert raised a bit of a chuckle:

(click for bigger)

This is not a video

As I mentioned previously, the opening presentation at TICAD was by Adobe and featured their vision of the future of Technical Communications and information development. Apparently that future includes video.

Video has been available to many for a few years now, yet it is never really the main focus of a documentation team. Tom has questioned this as well:

“For too long I’ve minimized the importance of the audiovisual. Captivate — the industry standard tool for creating screen demos — is actually a relatively simple application. Mastering it and integrating audiovisual into user help will take it to the next level.”

This echoes what Adobe suggest, no big surprise there, but I have to admit that I don’t fully agree.

As a quick learning tool, I’m sure videos (screen demos) are useful, but I wouldn’t really know as I’ve never used one as a primary source for learning about a product and I’m not sure I know anyone who has. Of course that’s not to say they don’t have value and with some research into the intended audience I’m sure it can be proven that they have a valid place in the product documentation set.

However my initial thoughts on the matter are hard to shake.

It may be one of the unwritten rules of documentation, the rules that few people question and may well be inaccurately applied, but I’ve always operated under the assumption that people only use the documentation when they are stuck.

Of course this is a broad sweeping statement but I believe that it is true for the majority of software users. So, if that is the case, what is their mindset when they finally give in (having asked a co-worker and searched Google to no avail) and fire up the online help or open the user guide? Typically they will be annoyed and want an answer or fix pretty damn sharpish.

Why, in that case, would they even consider sitting through a 2 minute video that explains how to use the functionality with which they are currently battling?

To be fair, Tom isn’t suggesting this approach but I think it’s wise to counsel against this trend lest it be used too heavily. A few short demos of how to complete core tasks, accompanied by a comprehensive help system or user guide is the best balance.

My fear is that the “cool” effect will override sensibilities and we’ll be plagued by popup videos and worse in the future.

The written word certainly isn’t the only way to effectively communicate information, and as technology progresses we will all need to carefully match the available delivery mechanisms with the information we need to deliver. The key word here is “carefully”.

I’d love to hear from anyone who is already doing something like this, I’ve not used Captivate, nor offered any form of video as part of a documentation set before as they didn’t match the audience profile but I’d be interested in hearing how successful they were.

Thoughts from TICAD 2007

Pre-Conference Dinner
The first day of a conference is always a little awkward, introducing yourself to complete strangers is always fraught with danger. So a ‘mingle’ activity is a nice idea, particularly as the TICAD conference makes some play of the networking opportunities, and the an informal dinner beforehand certainly made the following day a little easier. As it turns out I bumped into someone who worked at a sister company of my previous employers (it’s a whole complicated one company, then two companies, then one company thing), and we traded some names and stories.

Dinner was good, with many laughs and thought provoking conversation the kind of thing you get when you dine with a bunch of smart, friendly people. One topic which cropped up, and naturally I can’t recall why (did I mention the wine?) was Chess Boxing. Yes, that’s right, Chess Boxing. It was new to me as well.

The Conference itself is aimed at TechPubs managers and was celebrating its 10th year. Organised by ITR it has a focus on translation issues but is largely a TechComms focussed day. I’d heard of TICAD before but this was my first time both attending, and speaking at, the conference. The day was split into four sessions, the third comprising of two breakout sessions, the others more standard presentations. I took notes for all of the presentations but skipped the breakout sessions to go over my own presentation one more time.

Convergence in technical communications
The opening session was kicked off by Mark Wheeler of Adobe, and despite being fairly much a product pitch, it did outline Adobe’s thoughts concerning the convergence of various areas, with internal documentation, public documentation, Help systems, Knowledge Bases, training material and Demos all becoming more and more closely linked. All share similar traits, they all rely on high quality content for example, and organisations are beginning to realise the benefits of sharing information across these areas.

Part of the presentation did flummox me somewhat, and whilst it may have be a cool demo feature I do question the reality of usage. The idea presented was that by using embedded content within a document or help system, you could launch a video or “better still” initiate a text chat session or VOIP call to a support operative to help you with your current issue. Now, my belief is that, for that scenario, people want to get OUT of the help a.s.a.p. Why on earth would I want to sit through a video, or talk to someone and have to explain my issue, when all I want to do is get on with my work?

Naturally the focus was on the new Technical Communication Suite and overall it does look like it adds some value and will be of huge benefit to many technical communications teams. But then demos ALWAYS look good, don’t they…

Adapting structured documentation and DITA
When I saw this presentation listed in the agenda I marked it as one to attend. We are currently heading down the DITA path ourselves and Thomas promised to share some of the issues and pitfalls he and his team had come across. His presentation was excellent and hugely informative. A quietly spoken American, who was at our table for dinner, he covered everything I had hoped and more.

He covered the guidelines they had to put in place for help the writers cope with the move to structured authoring, including their 5 Glorious Principles (and yes I will be ‘borrowing’ this idea), namely that when writing topics:

  1. Standalone chunking - create discrete chunks that contain only information about the topic/type.
  2. Labelling - Titles are explicit, describe the topic (this also stops conceptual phrases like “this section contains” and so on).
  3. Relevance - the content matches the topic.
  4. Consistency - topics are written in the same way.
  5. Reuse - topics are written once and can be used many times.

Working in a large organisation they found they had to hire a dedicated Documentation Product Manager, to coordinate and liase with Technical Publications, Training, Marketing and all other information creators. They also hired a dedicated architect to manage their DTD.

Outlining the drivers for their change, with localisation being the biggest (numerical) business reason, he talked through the planning stages, and admitted that they decided to stick to topic-level reuse rather than ‘conref’ level reuse (in theory you can reuse any single element, so a paragraph or list can be used in multiple topics) although that is something they are currently addressing. As a path to ease the pain of migration it is likely we will do the same, so it’s good to hear others taking the same route.

Technical English made simple
I wasn’t too sure what to expect from this presentation, but was pleasantly surprised. Admittedly as it was focussed more on maintenance style procedures, for hardware, then the suggestions didn’t always apply to a more software oriented team writing (or moving towards writing) in a task based style, there were still many valid points to take home.

Amongst the commonly held truisms, such as writing with an active rather than passive voice, Maria expanded on these topics with several examples, and the basic premise that most technical documentation is easier to read, less ambiguous, and easier to translate, if you simply consider each sentence and make sure you are assigning the task to the reader.

At present we don’t translate our docmentation but I am more than aware that someday, soon, we will be asked to do so. Some of the suggestions made by Maria will form part of new guidelines as we adapted our writing style to be more translation friendly.

In-country translations
Helen Eckersley, of iTR, gave a presentation which I didn’t think I’d take that much from. Focussing on getting the most from the people who review translated material it largely followed general practise for making the most of any kind of review, technical, linguistic or otherwise.

However, as it the way of things, it’s always good to get a reminder of such things, and similarly to Maria’s presentation I did gleen some information that, if put in place, should make translation of our documentation a whole lot easier.

Helen touched on linguistic assets, containing glossaries of approved terms (cross-language), translation memories, style rules for acronyms, product names and so on. All things we can consider now and start to build ourselves.

Using Wikis for Collaborative Authoring
Some Scottish bloke stood up and waffled on about Wikis, illicited the odd smile and largely left everyone bemused.

Vision of the future
The final speaker was Bernard Aschwanden, who I saw present at X-Pubs earlier this year. He is an animated, charismatic and passionate speaker and was given somewhat of a free reign to pull together his Vision of the Future.

He opened with a video, one which I think I’ve linked to before and which still bears repeat viewing.

Frankly the video is enough to get the synapses firing but building on that, Bernad took us back through the history of Publishing, from the first clay tablets, past the Guttenberg Bible all the way to Playboy. He tracked back through the advances in the past 100 years of technology, and then headed into the future.

Breaking things down into two sections, the first of which dealt with the coming 5-10 years, Bernard offered his take on where the traditional Publishing processes would take us. The basic premise is the same, regardless of the timescale, but the way in which information is handled and managed will change. For example, at present we spend a lot of time fudging with DTP packages to get information into a form that is legibile for our readers, in the next 5-10 years that will no longer be an issue (it’s already not an issue for some people publishing from a CMS system, where the template is applied and any layout errors automatically dealt with by the software.

He then tackled 25-100 years and whilst at first some of his premises seemed laughable - pulling the uploading of information from the movie The Matrix for example - he quickly reminded us of the change in technology in the last 100 years.

However, one thing remains true and becomes crucial in the future. All of the sources of knowledge really on people to check and validate the information on which it is built. Those people are the technical authors of today and in 10, 25 or 100 years from now, we will be in a far more powerful position than we are today. Bear that in mind the next time you ask for a raise!

All in all a fascinating presentation which I’m not doing justice. If you ever get the chance to see Bernard speak, do so. You can always tell when people are passionate about something, and he also has the knowledge to back that up.

My final thoughts
Sitting, as I am, on the train on the way home, it’s easy to pontificate about the things I’ve learned. Everyone returns to work after such an event, with a little extra enthusiasm and grand plans for change. However this time I do genuinely feel that there are things I will take from this conference that I WILL put into action, some of them require little extra work but can have huge benefits, others will need more contemplation but are equally valid.

The conference was very slick and well organised, credit to Tanya, Sally and all the other guys and gals from ITR, they certainly made it a very relaxing experience for me, very much appreciated as it was my first time as a speaker.

If you are a team lead, a manager, or have any sort of big picture thinking about Technical Communications then I highly recommend you head along to TICAD next year, you’ll find something of interest without doubt.

Hopefully I’ll see you there.

Using Wikis for Collaborative Authoring

A big hello to anyone visiting from the TICAD conference. I’m writing this post in advance of the conference itself (the joys of scheduled publishing), so hopefully my presentation went well and you found it useful. I hope the page of links I mentioned is of some use to you and anyone else who pondering whether or not a Wiki lies in the future of their organisation (yes, it does!).

The very act of pulling the presentation together has been both fun and educational for me, it has helped me fully understand some things I took for granted and hopefully that is reflected in my words. My thoughts on the experience, and the rest of the conference sessions, will be posted here soon.

If you are visiting from the TICAD conference, please leave a comment, any and all thoughts, feedback and criticisms are encouraged.

I am a star!

OK, I’m not really, I have a tendency to mumble and, being Scottish, I talk faster than most (I put this down to the speed at which Scottish women talk, you have to be fast to get a word in edgeways.. ). My mind wanders off topic quite easily and I tend to try off-the-cuff jokes. However I have given a presentation to a room full of strangers before but this time I may not be the only expert in the room…

These are all things I know I need to be aware of on Wednesday when I give my presentation on “Using Wikis for Collaborative Authoring” to the TICAD conference attendees.

However, I think my presentation is OK. It’s not going to “knock ‘em dead”, I don’t think, but I think I’ve pitched it right and hopefully I won’t trip myself up too often. I’m going to run through it twice more before Wednesday and, as yet, I’m not hugely nervous about it. I know the topic well enough, and I think I could even talk through it if the conference system fails so that should stand me in some good stead. Mind you, ask me that at 3pm on Wednesday and I’m sure you’ll get a different answer. Still, I know that is all part of the experience and I have to admit I am genuinely looking forward to it.

It is a little odd, as this is my first time as a conference speaker, to be on the ‘other side’ of a conference and I’m not really that sure what to expect. My slot is right after the ‘breakout’ sessions, with a coffee break preceding me and the rather awesome Bernard Aschwanden following me. Which reminds me that I must ask him about the theme of his session “A Vision of the Future” as I’m slightly wary of treading on his toes (he’s shorter than me though so it’s not too much of an issue…).

Still, at least I’m not right after lunch.

If you are coming along to the conference, then please say hello. I’ll be there from Tuesday evening at the pre-conference dinner, and I’ll most definitely be in the bar on Wednesday evening. Mine’s a Guinness.