I’ve just completed a quick website edit for Moscripto, a lightweight scripting tool for Windows.

As usual, I’m left a bit ashamed that my client’s grasp of English was far better than my grasp of any other non-English language! (Blame the 1980s Scottish education system, or blame my laziness.)

Even so, he needed that last 5% to make the site sound as if written by a native speaker – call it post translation localization. That’s what I’m good at, and that’s what I did.

He liked the result:

Martin did an excellent job for my website copy and to my surprise his services were affordable for my tight budget. He was also very responsive often replying in minutes. Highly recommended.

Мартин направи одлична работа со преводот и проверка на точноста на Англискиот јазик на мојата веб страна и на мое изненадување неговите услуги беа прифатливи за мојот скромен буџет. Топло го препорачувам секому кој има потреба од технички автор за Англиски јазик.

 

I wonder whether the original designer of MS Outlook suffers the classic recurring nightmare of being out in public with no pants?

MS Outlook is missing a feature so blindingly obvious and necessary that it comes as a shock to find it’s not there:

Tasks with due dates don’t appear on the Calendar!

Really! Don’t believe me? Go check.

Yes, it’s true. As designed, the Calendar and the Tasks are two distinct subsystems… like room-mates locked into a permanent sulk… or the AD&D Brawl and Combat systems.

It’s frankly bizarre that a behemoth like Microsoft could put out a product with such an obvious omission. So, if the Outlook designer does have those nightmares, it’s probably because he or she is sufficiently forgetful to have genuinely gone to work sans-jeans!

"Call client" is actually a task...

Fortunately, there’s an independent software provider willing and able to hand you a pair of chinos to cover the shame of your particular Outlook installation…

TaskToCal syncs the MS Outlook calendar with the task list. Tinker in one place and the changes appear in the other.

Oddly, this little masterpiece didn’t require much documentation. However, I was glad to get the gig, especially because I got to make some suggestions about streamlining the UI text. I delivered my work as a Help and Manual project, and the client was very happy:

“Do you love writing software but you hate writing documentation? Then don’t burden yourself any longer. Ask Martin to do this job. The result is pragmatic and overwhelming at the same time. He does his work on time and delivers more than you expect.”

Drop me an email to see how I can help you with your documentation…

 

 

If you know me at all from my online presence, you’ll know I have a thing about good interface design.

I don’t mean the sort of fancy theoretical considerations they teach you in HCI courses. I mean just the basics:

  • Make the interface reflect its real world domain.
  • Keep navigation simple and consistent.

Late last year, I was lucky enough to work on documentation for a system that’s a good example of how to “do it right”.

FastMaint essentially turns your PC into the equivalent of a fully-staffed maintenance office. Not only does it handle work orders and the resulting workflow, among other things, it also tracks inventory, rostering, locations and equipment. It even warns you if you’re trying to do something impossible or unwise…

With so many different entities to manage, this could have been a horribly complex piece of software. However, the SMGlobal team managed to make the product so intuitive that even a deskbound techwriter such as myself quickly made sense of it.

They achieved this by putting in the hard work required to keep the interface consistent and convenient. Here’s an example:

 Locations and Equipment

  • If you’re a maintenance professional, then all this should make sense to you, even if this is the first time you’ve seen FastMaint!
  • If you’re looking at an entity or list of entities – here, equipment located in a building – then there’s a button to create or add a new one.

In short, you – the user – can concentrate on the task in hand, without wasting brain space on the software.

All this may not be rocket science, but it requires the sort of thoroughness you associate with building an actual rocket:

  • Somebody must have gone to the trouble of learning the terminology used in maintenance departments, then made sure that the screens reflected it. (This probably meant acting as a sharp-eyed gatekeeper whenever developers became “creative”.)
  • Somebody else had to slog through the UI, putting in all those buttons, creating all those editors…

When they graduate from college, most young coders dream of wrestling with algorithms and architectures, not putting in the kind of meticulous effort on display here. However, if this were a launch vehicle, then I’d cheerfully ride it to the stars.

If you don’t believe me, download the application and take a look for yourself.

If you do that, you’ll also see my streamlined documentation that builds on the application’s ease-of-use.

It’s usually harder to cut, rather than expand, text, and there’s always the fear of leaving out Something Important.

However, my contact at SMGlobal, Sanjay Murthi, pronounced himself

…happy that you have been able to reorganize and simplify the help documentation.

So, I like to think I’ve turned out an online help worthy of the product.

 

I just had a nice email from David over at what’s now AnyRail:

Just wanted to forward this little bit of praise to you from one of our customers:

 ”I was reluctant to invest in any planning software.  I recently stumbled onto your website and started playing with the free download.  I was hooked immediately.  Also, AnyRail has done a very good job with the manual – it’s clear and to the point.  You guys think like humans instead of software designers.  Great job. ”

Thanks again for your great work last January.

Mostly, customers only send you an email when something’s wrong! So, it’s nice to think that this customer felt moved to put finger to keyboard because something was very right….

It’s certainly an indication that good documentation helps to sell products, especially when the potential customers expect to download free trial versions. If they can’t get the thing working within a few minutes, the chances are they’ll hit Uninstall and “Move on down the line” (to your rival’s product).

 

This year, I’ve been too busy to update this blog! I take that as a hint that it’s time to adjust my rates to EUR 60 per hour.

Small quirky project in interesting location

"I'll always be a sucker for start-ups with quirky products, and for companies based in interesting locations..."

I’ll keep on fixing prices upfront, so there’ll be no nasty surprises. As before, there’ll be discounts for small projects I can fit in between the big ones. And, I’ll  always be a sucker for start-ups with quirky products, and for companies based in interesting locations…

This year I’ve done a lot of work on user-interfaces, ranging from simple post-translation localisation, through to full reports on structure and usability (I like to think of this as “pre-emptive techwriting”). I’m going to add this to my list of core services – just as soon as I can work out a consistent pricing system!

I’ve also put in a good few hours working on website text. Sometimes clients just needed me to check the English. Other times, I’ve created the website copy more or less from scratch. It’s similar to my regular documentation work, but requires more thought and hence more time. That’s another service to add to the list once I’ve had time to think about pricing.

What hasn’t changed is that I’m still fast, still friendly and still having fun. So, roll on 2010!

 

One of my regular clients is GdP Software, a Dutch-based company. They use me for localisation of web text and emails, and for documenting products such as watchFTP, a powerful tool for monitoring FTP directories and processing any uploaded files.

In explaining my work to a translator, Gert (my main contact) neatly summed up what I do…

So the original text was…

blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-bl a-dee-blah-dee-blah-blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-blah- dee-blah-dee-blah-blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-blah-di e-blah-dee-blah-blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-blah-dee- blah-dee-blah-blah-dee-blah-dee-blah-blah-dee-blah-dee-blah-

After DD’s changes it is…

To do blah-dee-blahh:

1. Blah-dee-blah blah blah

2. Blah blah blah

(With several spelling errors corrected.)

He was of course, correct.

I’ll cheerfully admit that I don’t do anything special, but what I do do, I do very quickly indeed, and from the user’s point-of-view. This makes it more cost effective to use me, than to lock some poor coder in a room with a Help Authoring Tool – and I’ve yet to see a HAT that’s both user-friendly and powerful – and a copy of Technical Writing for Dummies.

EDIT: When I told Gert about  this blog post, he said I could quote him on the following:

Working with Documentation Doctor is a pleasure, he works quickly and for a reasonable fee. If you have any doubts or questions, feel free to contact me: gert at watchftp.com

 

Tragedy of the CommonsThe Tragedy of the Commons - as any economist will tell you – is that people tend to use shared resources until they break. 

Shepherds slip an extra sheep onto the common land until it’s a desert, people leave their rubbish at picnic sites until nobody wants to eat there, drivers take shortcuts until the side-roads are clogged, sunbathers turn up their stereos until nobody can hear anything… and nowadays, “trolls” and “spammers” choke up Internet forums with the intellectual equivalent of white noise, or worse.

DeepTrawl is intended to stop this happening to your patch of the web.

It’s like having a killer robot to cull illicit sheep, sweep up the rubbish, keep people on the highway, and jam noisy stereos, that also checks the footpaths and updates the signs, and even returns lost wallets… OK, I’ve probably pushed the analogy a bit far.killer-robot.jpg

In a nutshell, DeepTrawl sweeps for inappropriate forum postings, including credit card numbers, and checks your site for spelling, valid links, and optimal design. It even suggests possible improvements.

So, maybe a killer robot with a friendly geek inside.

You’ll understand, then, if I approached redrafting DeepTrawl’s documentation with a certain trepidation. However, despite being a powerful bit of kit, DeepTrawl is easy-to-use, with most of the important features no more than a click away.  The only real challenges were its very technical  capabilities, but a few iterations via email nailed these.

Jonathan Matthews of DeepTrawl seemed satisfied with resulting HTML help pages:

Thanks for the great work! This really helps the usability and  professionalism of DeepTrawl and I found the process very easy. If you ever want a recommendation just shout!

 

“Crusader” tank kitToday,  I built an 1/72 Scale “Crusader” tank with my son. “Yes, Daddy, but what was it for? Was it any good?” We paraded through to the computer room. A few moments on Wikipedia gave us a pretty good answer, and Youtube has footage of the under-gunned armoured fighting vehicle trundling around at a show.

A few years ago, we’d have had to make a special trip to the library or thumb through military bookseller catalogues for something on 1940s British tanks.

Maybe next year, all I’ll have to do is point my mobile at the barcode.Barcode in action

There, in my hand, will be archive footage… original blue prints… historical details… links to Museums… an invitation to enter a competition by uploading a photo of the finished  model… and links to other model kits and related books.

A few clicks and I’ll be happier, and perhaps a little poorer – can’t… resist… those… tank… books – and I won’t have even got up from the workbench.

It’s called Mobile Marketing, and it’s turning the world into a point-and-click environment.

The snag with Mobile Marketing is that it mixes the Internet with mobile devices and the real world. You have to be able to field and send text messages, put up special mobile-friendly websites (WAP pages), generate barcodes… all technical stuff, some of it quite complex.

Historically – in this context, that means perhaps “the day before yesterday” – the complexity was expensive. You had to be a big player or a gambler, because no excursion into new marketing channels is guaranteed to How Moozey workssucceed.

Then, along came Moozey. They’ve automated the thing. You can sign up, design a campaign, activate it and analyse the results, all online. You don’t need to speak to a salesman or any other sort of rep.

They’ve not so much “cut out the middle man” as done away with consultants as well, reducing the whole thing to just another application, albeit one you use on the web. Better yet, they’ve hacked down the cost down to the point where you can afford to test the waters.

Products that hide their power behind a simple interface are always impressive, so I was very pleased to be asked to help optimize Moozey’s documentation, check the interface for consistency, and give the homepage a polish.

Working on software that’s undergoing development is never a “surgical strike”; you have to engage with the product and its purpose, and build up real working relationships with people you’ve never met, while at the same time not getting underfoot. I think Can, my contact at Moozey, feels the same: 

As a fresh startup developing Moozey, we were constantly in rush; trying to catch up with our countless project deadlines. We are glad that we have found a “co-worker” like Documentation Doctor. Most of the time he was even faster than us, completing his job always in a timely manner and in perfect quality. He is now virtually a part of our team and we hope he will continue to work on Moozey and our other future projects.

In truth, I had such fun messing about with the Moozey user account, I even considered replacing my old mobile with something that can actually read barcodes and display WAP pages…

 

I hate PowerPoint. It can’t decide whether it’s a wizard or a WYSIWYG, and in falling between the two stools makes the sort of mess you’d rub a puppy’s nose in.Alpine landscape with mercenaries

Of course, I do use PowerPoint. It’s one of those business tools you can’t avoid, not so much “Best of Breed”, rather “Least Bad of the Bad Bunch”. What I don’t get is people who use the thing for fun!

The worst crime of all is afflicting your friends with a PowerPoint presentation of your holiday snaps, with all those “special effects” that remind one of unemployed double-glazing salesmen in nylon trousers trying to learn how to sell used cars. A few minutes of that, and most sane people will be reaching for the nearest blunt object.

Slide Effect is designed to save you from being bludgeoned to death with your own holiday souvenirs. Instead of grudgingly slumming it as a slide machine, Slide Effect lets you turn your pictures into a high-energy audiovisual extravaganza, with synchronized music and cinematic special effects.

Though it won’t – unfortunately – kill PowerPoint, Slide Effect does come from that mountainous land formerly known for its professional soldiers. For this reason, Alain Bocherens, brought me in to localise his website and tune up the presentation of the application’s easy-to-use features.

Once he’d applied the changes, and well after he’d paid me, I checked over the website for typos, and things that didn’t actually work in context. I’ll admit I was partly motivated by fear of being skewered to death by Swiss pikemen, but it was worth it. Alain said:

If I need another documentation/proof reading task I won’t hesitate to work with you again.

 

Armenian Cataphracts!Until Tigran contacted me on behalf of RIATest – thanks to my rather eclectic educational background – when I thought of Armenia, I thought of its famous cataphracts, the ultra heavy cavalry who gave the Byzantines and others a run for their money at a time when many warriors in my neck of the woods still considered a coat of blue paint was appropriate battledress.

Imagine my surprise, then, to discover that many Armenians are nowadays happiest doing battle with complex programming challenges, in this case resulting in RIATest, a powerful tool for automatically testing Adobe Flex applications.

When I see products like this coming from formerly “obscure” corners of the world, I start to wonder how long it will be before we Brits start to feel like the naked guys daubed in woad again! The thing is, thanks to the Internet, physical distance is no longer a protection.Paint is the new kevlar

When I localised a press release and revised the documentation for RIATest, Tigran said:

You delivered good work which was essential for our website and documentation. The project went smoothly and I would not hesitate to recommend your services to others…

So, I can rest easy knowing that I’ve established cordial relations with our possible future overlords.

© 2012 Documentation Doctor Suffusion theme by Sayontan Sinha