The following is an interview with Ugur Akinci, a technical writer for Honeywell Corporation. Ugur asked me these same questions for an interview on this site. After answering them, I was curious about how he would answer the same questions, so I asked Ugur to respond to the questions for my site as well. (1)   How long you’ve been a technical communicator? Where do you … more »

My colleagues and I were talking the other day about where we’re going to publish some help content. The scenario we’re addressing is a project that will be translated into 38 separate languages. Additionally, there are 28 roles for the system. This means there would potentially be 1,064 outputs (38 x 28), assuming help is to be specific to each user’s language and role. This is a … more »

Let’s fast forward a year. Assume you have explored Swordfish and have hammered out a lot of help topics — nearly 200 help topics, in fact. You have met with subject matter experts and extracted critical information from them for many months. You have explored Swordfish inside and out, documenting every possible task and setting, and now you have a ton of content. The help … more »

In a recent email to me, Jake from California (not his real name or location) writes, I’ve spent most of today exploring the world of technical writing, and I find that you’re very central and visible. I’ve read, listened to, and watched a good deal of content you’ve produced, plus viewed snippets of threads on the STC listserv where you either weighed in or were … more »

[Audio clip: view full post to listen] Download MP3 Length: 38 min. In his controversial post, The Myth of Single Sourcing, Michael Hiatt explains: Single-source publishing is a zombie idea that revives itself periodically and refuses to stay dead. Its zombie supporters chant its purported benefits as a “write once, publish to many” promise and ploddingly follow it as their ultimate goal for mechanized authoring and machine … more »

I read a blog post the other day that I can’t stop thinking about. In the Myth of Single Sourcing, Michael Hiatt writes, The main issue for me is between authoring static in-house documents using single-sourcing methods before publishing, or capturing information sources dynamically after publishing from online social networks, linked data sources, and knowledge mashups. The myth of single-source authoring is that it actually … more »

Everyone knows it’s a good practice to chunk your help material into discrete topics, but how granular should you chunk it? Take a look at this Microsoft Word 2007 help topic on inserting headers and footers. Although inserting headers and footers is the main task, the topic really has 11 related tasks: Insert the same header or footer on each page Make the first page … more »

[Audio clip: view full post to listen] Download MP3 (right-click and select Save Target As to download) Duration: 60 min. In this podcast, Liz Fraley, founder of Single Sourcing Solutions, talks to the Intermountain STC chapter about “Repurposing Content for Multichannel Publishing.” See this flyer for a more detailed description of the presentation. Liz Fraley is the founder of Single Sourcing Solutions. You can read … more »

In a recent IT Author podcast (“Documentation and Agile Development“), Alistair Christie and Graham Campbell talk about agile development and its impact on documentation. One consequence of working in an agile environment, they say, is the need to prioritize your documentation, to deliver instructions for only the most important or confusing features. Presumably, some agile environments move so fast, you have to triage what you … more »

Resources for Single Sourcing Projects

helpstuff blog – Whats a topic?.

When you single source from an online help authoring tool and generate an output to Microsoft Word, almost invariably you have some clean-up reformatting to do. For me, one of these areas deals with screenshot images. I prefer to have Word resize my screenshots (to a smaller size) because images look a lot sharper and crisper when Word resizes them rather than when SnagIt or … more »

Madcap Flare is one of the most advanced, functionally robust online help tools for technical writers who want to single source their content. When you use Flare to create an actual project (rather than just experimenting with a trial version), you come to know the ins and outs, the major benefits and the quirks, its usability and learning curve, the things you love and the … more »

For a long time, I looked at help authoring tools in terms of their single sourcing ability — creating the source material in the tool, and then outputting to online help, print, and other targets. However, I’ve given up on the ideal, at least for now. I’m convinced that the new vernacular, as a SXSW podcast called it, is audio and video. If faced with … more »