Testimonial – Clear and engaging style

Jason’s clear and engaging style carries over from his writing into his instruction. He happily goes out of his way to ensure participation and understanding.

Pritpaul Bains, Technical Writing Student, BCIT
(now Marketing Technology & Operations Manager at Macmillan Publishers, New York City

Doing the Right Thing

Yesterday, I toured the Basilica de Saint-Denis in the Paris suburb of the same name. Why, on my first day in Paris, I would visit the suburbs may be a mystery to some, but I wanted to start at the beginning and in terms of basilicas and Paris and indeed France, this is where it all begins. Saint Denis is the patron saint of France and his remains are interred here along with those of a great deal of France’s royalty from Dagobert to Marie-Antoinette.

I started in Saint-Denis not just to see the gothic church that inspired all others—Saint-Denis’s firsts include its beautiful rose windows, and its pointed arches—but I think there’s an anti-revolutionary spirit in me. I know that revolutions never replace an ancien regime with anything better, if the revolutionaries do not live the qualities they aspire to. It’s always an inside job. Gandhi had it right.

Over the last few months, I’ve been given the opportunity to place my values in front of my needs and am the better for it. There is a business application for this that I embrace—it has to do with doing what’s right. Here are three examples:

  • At the tail end of a contract, my manager was let go and I ended with four days of my time owing to the company. Later, the replacement manager asked me if he could hire me back. This is common sense, but while I could have signed a new contract and never mentioned the four days owing (nobody but me would have known), I offered up my four days. As the new manager didn’t know what sort of budget he had, this was enormously helpful, and later paved the way for him to hire me back for an additional four-month contract. Honesty is its own reward.
  • Likewise, I quoted 24 hours to a client to copy edit his 30-page financial report. I must be getting good at copy editing because the entire job (including the copy edit and designing a new template and style sheet), took me only 6 hours. With the previous example of integrity in my head, it was easy to ignore the little devil on my shoulder and bill only my working hours, not the proposed contracted hours.
  • Finally, a fellow musician in Montreal put out a panicked message to all her clarinet-playing colleagues on facebook for a certain part of music she needed. I responded that I was too busy packing for my trip to help her. During the day though, I kept thinking about that rare clarinet part and gradually found that it was easy to locate it in a box of my music, scan the section she wanted, optimize it into a compressed PDF, and finally post it to my site where she could download it.

The fascinating part for me was not that I did these things, but that they got done simply by me not resisting their accomplishment. I under-promised and over-delivered.

Basilica Saint-Denis

Where it all begins

Testimonial – Great respect for accomplishments

Thank you for your insights and motivation! I have great respect for all your accomplishments and wish you all the best.

—Trevor, copy edit client, December 2011

Communication – How to Keep your Clients Happy

I sit in cafés watching the patrons tapping away at their laptops or PDAs and wonder how many of them are billing hours for their labours. If they are, I also wonder how they maintain communication with their clients. Are they off in a dream of worker freedom or are they providing value for their clients at least as effectively as if they were in the corporate office?

Having worked from home as both employee and contractor, I know that the only way it can be effective is if I can ensure that the trust between me and my clients (boss) is rock solid. How I do that is through communication. Below are some of the communication tools I’m using:

Skype Skype is a software application that allows users to make voice calls over the Internet. It’s one of my favourite tools—so much so that I often use it during business hours in Vancouver to save my cell phone minutes. Last year, when I was in Portugal, I found that the Skype connection on my iPod (needs WiFi) was better than on the laptop.
Google Talk Google Chat is good because your clients can contact you on a moment’s notice (provided you both have it open). By seeing I’m online and available, my clients can have the assurance that I’m working on their projects, etc. etc.
Cell Phone Want to run your laptop and phone abroad and not sure what to do? I was in Foreign Electronics the other day picking up a power adapter and they advised me to remove the SIM card from my phone on arrival in France and just use my phone for WiFi only. I’ve already ensured that all the hotels where I’m staying have WiFi, so if I need to talk, I can use Skype. If I want a cell phone, I can pick up a local SIM card (check that your phone accepts one – my iPhone 5 doesn’t).
Web Texting Most cell providers, such Roger’s, allow you to send and receive text messages through their web site free. So, if you’re working very remotely from, say, the south of France, you’ll want to keep your texting as low cost as possible.

Grammar tip – Misplaced and Dangling Modifiers

Check Sentences for Misplaced or Dangling Modifiers

Let’s face it, misplaced and dangling modifiers are just plain fun (as long as it’s not you who writes them). A misplaced modifier usually just doesn’t make sense, because they appear to modify the wrong thing.

After our French lessons, we could understand the French spoken by our visitors from Québec easily. It’s misplaced because it sounds like the visitors spoke easily, when it’s our “understanding” that should be modified. “…we could easily understand…”

A dangling modifier often renders the sentence hilarious. The most famous example of a dangling modifier is by Groucho Marx:

One morning I shot an elephant in my pajamas.
How he got into my pajamas I’ll never know.

There are web sites exclusively devoted to documenting them.

Here’s another example: “It wasn’t long before the two got engaged, lived in several Canadian cities, pursued their separate career paths and explored their new surroundings while weighing the pros and cons of each.”

What are they weighing the pros and cons of?

  • Their surroundings
  • Their separate career paths
  • Several Canadian cities
  • Their engagement
  • All of the above

Avoid Ambiguous Pronouns

Avoid Ambiguous Pronouns

Ambiguous PronounThe best way to avoid this kind of confusion (what kind of confusion? The confusion that results from ambiguous pronouns), is to read your copy carefully checking that you can  identify the noun that belongs to the pronoun.

If more than one noun emerges as a possibility, replace the pronoun with its intended noun.

“There’s a high fly ball! Winfield goes back. His head hits the wall. It’s rolling toward second base.”

What’s rolling toward second base?

  • The ball
  • The wall
  • Winfield’s head

 

Simplify Tense

Simplify Tense

Unless you’re a time traveller (and therefore familiar with temporal paradoxes), you’ll be confused by sentences where the writer did not follow a logical progression in time (that skipped writing course at university would have helped now) and now covers too much temporal real estate in a single sentence—don’t you start doing this!

English has twelve tenses. Present tense is the only real tense—all the others are factors of our imagination. The best rule of thumb is to stick to the present tense as much as possible and make occasional forays to other tenses as needed. Don’t make time travellers of your readers by hiking them hither and yon through your temporal landscapes.

EXAMPLE: “Madonna removed her wedding ring before she appeared last week sparking rumours that her marriage is on the rocks.”

Testimonial – A great addition to the team

I would like you to meet Jason Hall, the fellow that will be working on the content for the site. We have worked with Jason in the past; as previously mentioned and find that he will be a great addition to the team.

—Tim Lloyd, Portal 80 Multimedia Inc. (service provider to Webtech Wireless)

What’s a Technical Writer Worth in Vancouver?

My students frequently ask me about salary ranges for technical writers and, occasionally are confronted with their expected salary range on a first job interview. Based on Stats Canada information, you can add a job title, city, and province and find out what the salary range is. Here are the latest statistics on what salaries technical writers get in Vancouver:


Try it yourself.

Use Active Voice

Use Active Voice

Tricky Dick

The phrase, “Mistakes were made” is attributed to US President, Richard Nixon, to acknowledge that the Watergate situation was mishandled. He could have spoken in active voice and said, “Mistakes were made by me” or better still, “I made mistakes”, but he evaded direct admission of responsibility and thereby went down to history as Tricky Dick.

There are three times when it’s appropriate to write in the passive voice:

  • When the doer is unknown. “My bass clarinet was removed.”
  • When the doer is unimportant. “The lab rats were given a placebo.”
  • To protect the doer from embarrassment. “You were overcharged for your purchase.”

TIP: In technical writing, you can distinguish between general concepts and action-oriented procedures by writing the former in passive voice and the latter in active.

Using active voice in web writing adds interest and action to your writing. Good sentences begin with a clearly stated subject (the doer) and a strong verb (action). While it is a commonly used verb, “to be” is passive as it describes a state of being rather than doing. So the more you use “to be”, the more passive sounding your writing will be. Also, some verbs are weaker than others. The verb “to understand” is weaker, because it is harder to quantify and tends to get lumped with another verb that’s doing the real work.

EXAMPLE: To understand how to run for President of the United States, you must have friends in high places.