Skip to main content

Author: Alan Pringle

Localization

We’ve been localised

Over the years, I have worked on manuals that were translated, and I have helped clients with their localization processes. Despite those experiences, I’ve never been part of a project in which US English was localized (well, localised) into UK English–until now.

Cherryleaf has adapted material from our Technical Writing 101 book in its new Basics of Technical Authoring self-paced course. Cherryleaf is based in the UK, so the course is tailored for those accustomed to British English, but the content is helpful to any English speaker who wants to learn the basics of technical writing. Cherryleaf has also included exercises so students can get some experience applying the techniques explained in the course content.

(Full disclosure: Scriptorium is compensated for sales of Cherryleaf’s course.)

Alan Pringle
November 21, 2008
Read More
Structured content

The Golden Rule of technical writing

I stumbled upon a list of tips for technical writers, and I was glad to see tip 7:

Understand Your Target Audience. Write and revise your content according to how your target audience thinks and understands things. Getting into their heads–knowing how their minds process information, how they might react, what they feel is important–allows you to customize your content to tailor-fit their needs.

I would put that tip at the top of the list, but that’s a quibble.

Sarah and I mention the topic of audience a lot in our Technical Writing 101 book; I think it is the most important thing for writers to remember as they create content. You can have an elegant XML-based publishing system that generates all sorts of output with the push of a button, but if your information doesn’t address the needs of users, all the work put into the content and into the process itself is wasted.

That waste becomes even more acutely painful when a user abandons your information and finds helpful content on a blog, wiki, or forum. The contributors of that information probably don’t know (or even care) that they followed the Golden Rule of technical documentation: Audience, audience, audience.

Alan Pringle
October 6, 2008
Read More
Brand credibility Business case/ROI Structured content

Content creation isn’t just for tech writers

We’ve seen an increase in the number of clients who need documentation processes that include input from part-time contributors (particularly engineers). XML-based workflows make it easier to handle this sort of input. Part-time contributors can enter their information into forms or can edit XML documents in an editor that doesn’t require them to know a thing about publishing tools.

UC Irvine seems to have picked up on this trend in collaboration: the school’s extension program just announced a technical writing class for engineers:

“This course is designed to provide students with writing skills tailored for the science and engineering fields and to correct common problems,” said Jessica Scully, M.J., instructor of the course. “It covers the importance of writing for a particular audience, and applies journalism skills to help students effectively create a focused and concise document.”

The benefits of such a program go beyond engineering. Improvement in the quality of developers’ writing would likely mean a reduction in the cost of creating a more unified voice in content (which in turn would lead to a smoother localization process). And last but not least, the end users (internal or external) would get better documentation.

This class could also help engineers gain an appreciation of the skill sets technical writers bring to an organization. That being said, it would be unfortunate if a company made the short-sighted mistake of thinking that sending engineers to a class like this would transform them into instant technical communicators.

Alan Pringle
February 27, 2008
Read More
Food & fun Structured content

Your beautiful life

I just installed a wireless mouse on my PC here in the office. The instructions that came with the mouse have some interesting turns of phrase, including this gem:

[The mouse] combines with 27MH RF wireless technology, user-defined keys, and outstanding design, so that you can use it freely to improve your efficiency and enjoy your beautiful life from the high technology.

Yes, I often enjoy my beautiful life with high technology. Don’t you?

Alan Pringle
April 4, 2007
Read More
Industry insights

Ten for ten: training discounts until January 31

In 2007, we’re celebrating our tenth anniversary at Scriptorium. As part of this milestone, we’re going to offer discounts and giveaways throughout the year.

Our first special is 10 percent off any public training class on FrameMaker, XML, XSL, InDesign, or Photoshop. To get the discount, use the following coupon code during the checkout process in our online store:

10for10training

The code is valid through January 31, so register soon! For class dates, go to our online calendar.

Fine print on the discount: You can use the discount code only one time, so if you want to take multiple classes, register for all of them in one order.

Alan Pringle
January 12, 2007
Read More
Content management

Online learning isn’t just for colleges

A recent study found that the number of students in online college classes is still rising:

Roughly one in six students enrolled in higher education – about 3.2 million people – took at least one online course last fall, a sharp increase defying predictions that online learning growth is leveling off.

Cost savings play a big part in the continuing upswing for online learning at the college level, and that is true of our online classes, too. Neither the students nor the instructor need to book flights, rental cars, and hotel rooms, and those costs can be considerable. The financial incentives go a bit deeper than that, though. Each day of our online classes is about 4 hours (2 hours of interactive instruction and 2 hours of “homework” for the students), so students still have time to handle other job responsibilities. It also means our instructors have time to do other work here at our office. (And let’s not forget the wear-and-tear associated with travel today: spending a lot of time on airplanes packed like sardine cans is no one’s idea of fun.)

Overall, we’ve been pleased with our first year of online teaching. Even though having an instructor with you in the same room is probably the best way to learn software and technology, the cost of classroom training eliminates it as an option for many folks. We recognize that, and that’s why we decided to offer online classes. Based on our experience so far, we feel they are an excellent compromise between do-it-yourself learning through books and the classroom experience.

Alan Pringle
November 10, 2006
Read More