Writing, visuals, and Wonderful Life with the Elements  Clip to Evernote

Wonderful Life with the Elements - cover One of the most difficult writing tasks is to combine visuals with words. And I’m not just talking about writing scripts. I’m talking about writing documentation and tutorials.

The difficulty goes beyond melding diagrams and flowcharts with your text, too. How about using visuals and words to present complex material? While it’s been done for decades, the results have varied from being quite effective to not quite hitting the mark. And if you’re not a very visual technical communicator (it’s OK, I’m not incredibly visually oriented) doing the job well can be challenge. To say the least.

If you’re willing to take the time to learn how to effectively meld words and images, then you’ll want to give the book Wonderful Life with the Elements by Bunpei Yorifuji a look. It’s described as:

an illustrated guide to the periodic table that gives chemistry a friendly face

And the book also, whether the original intention was there or not, provides a solid template for explaining a complex topic by melding text and visuals.

Let’s take a brief look at Wonderful Life with the Elements.

Continue reading

Tasting a little Confluence, Tech Comm, Chocolate  Clip to Evernote

Confluence, Tech Comm, Chocolate Wikis have been part of my professional freelance writing and technical communication lives for a number of years now. I’ve used them extensively and even maintain my own wiki; I’ve written with and about them; and I’ve even set up a few documentation wikis. While a couple or three people have generously suggested that I’m an expert in this area, I’m not. Far from it, in fact. I still have a lot to learn.

To do that, I turn to others who know a lot more about wikis than I do. Folks like Stewart Mader, Alan J. Porter, and Sarah Maddox. And it’s Sarah Maddox, or at least her new book, that sparked this blog post.

Being the aging, jaded person I am I don’t get excited about much. When I learned that Sarah was working on a book on using wikis specifically for writing documentation I got excited. As a technical writer for Atlassian (the folks behind the Confluence wiki), Sarah lives documentation and wikis — all of Atlassian’s documentation is delivered with a wiki. I was expecting a comprehensive look at using a wiki for documentation. And I wasn’t disappointed.

Let’s take a closer look at Confluence, Tech Comm, Chocolate.

Continue reading

Storyboarding: not just for movies  Clip to Evernote

Storyboard A time-honored technique among anyone making a movie is to create a storyboard. A storyboard is a shot-by-shot breakdown of each scene in the movie. It doesn’t need to be detailed. It just needs to show how each shot can be composed and how each scene can play out.

So what does this have to do with technical writing? Quite a bit. Storyboarding isn’t just for movies. You can use it for any kind of writing that has a visual flow, like screencasts or presentations.

I use storyboards when creating presentations and screencasts. Let me explain how.

Continue reading

Take a cue from the trades when starting your business  Clip to Evernote

When you’re starting out as a freelance technical writer (or in any business, for that matter), you run into difficulties and choices. Like how to hang out your shingle, how to market your wares, your pricing structure, and more.

One way that you can do this is canvass other freelancers. That might net you some information. Then again, there are freelancers of all stripes out there who play with their cards close to their chests. They might be reluctant to share information, especially with someone who they perceive to be a potential competitor.

A couple of weeks ago, I was going through some notes when I came across some thought I’d jotted down during FSOSS 2010. One of the blocks of notes had to do with some interesting advice from a speaker named Karlie Robinson. During her talk, Robinson said that you can adopt business models that the skilled trades use.

You’re probably asking yourself What do the skilled trades have to do with technical writing?. Well, you can argue otherwise but technical writing is a skilled trade. And if you don’t look at it that way, you should. And there’s a lot that you can learn, as a budding business person, from the trades. The nuts and bolts of the two businesses might be different but many of the underlying concepts apply to both.

So, if you know someone in the trades or having some work done, see if you can get them to answer some questions. Like what? Robinson suggested:

  • Where do you make your money, products or services?
  • Is there a particular niche that you focus on?
  • If so, how did you find it?
  • How do you structure your menu of services and your pricing?

The answers you get might surprise you. And with a little thought and imagination, you might be able to solve the problems you’re having or come up with a niche that suits your skills, experience, and interests.

Anyway, it doesn’t hurt to ask. You never know what you might learn!

Thoughts? As always, feel free to leave a comment.

Photo from Photoxpress

Making people aware of documentation, and encouraging them to use it  Clip to Evernote

RTFM, please! I don’t own a car. And I haven’t since I gave mine to my parents over seven years ago. That perplexes a number people I know, many of whom can’t get along without their four-wheeled metal boxes.

While I am member of a local car sharing service, most of my travel through the city is done on foot, by bicycle (I own a really nifty folding model in case you’re wondering), or by public transit. For all it’s flaws and all the complaints, Toronto’s transit system isn’t too bad. Not the best I’ve used, but not too bad.

Watching my fellow riders is an interesting exercise in observing human behaviour. I won’t go into too many details — I’ve ranted and joked about that elsewhere. Let’s just say that for the most part I don’t have a very high opinion of people who ride transit in Toronto. They seem to turn their brains off and be oblivious to their surroundings; I have several bumps and bruises to prove that!

But watching many riders is also a good case study in how people use (or don’t use) documentation.

Let me explain …

Continue reading

Favourite posts from 2011: musings on various topics  Clip to Evernote

Sometimes, we just let our imaginations and thoughts take over. And sometimes that leads us to write what we think are some very interesting blog posts. Here are a few of them: