Allow me to introduce Jason Hall. He is a fellow instructor with BCIT’s Technical Writing Certification program, teaches on a variety of subjects, and is quite well regarded by the students.
—Steve Bain, Technical Writing Instructor, BCIT
Allow me to introduce Jason Hall. He is a fellow instructor with BCIT’s Technical Writing Certification program, teaches on a variety of subjects, and is quite well regarded by the students.
—Steve Bain, Technical Writing Instructor, BCIT
The Editors’ Association of Canada-BC presents
A One-day Seminar
If the job of the technical editor is to make complex subjects accessible to normal people, why is it that so many technical documents fail. What is the real job of a technical editor?
Using real-life examples and humour, Jason will demonstrate just how spectacularly technical documents can fail and how you can become an advocate for excellent documentation. This hands-on workshop helps you assess your own skills while exploring what it is technical writers do. By the end of the workshop, you’ll have developed your own toolbox of skills that technical writers need to succeed.
When: Saturday, November 27, 10 AM- 4 PM
Where: SFU Harbour Centre, room TBD
515 W. Hastings St., Vancouver, BC
Instructor: Jason Hall
Cost:
About Jason Hall
Jason Hall has over 15 years of technical writing and training experience and brings excellence to all his documentation endeavours. He has prepared industry-relevant user manuals and training materials for a great variety of industries from law enforcement to inventory management to health care software products. Past clients include SAP, Best Buy, WorkSafeBC and Health Canada. Jason is comfortable with the full documentation development cycle including interviewing subject matter experts, creating documentation needs analyses, and converting product specs into accessible end-use documentation.
Replace the non-standard English words with their English equivalents. Word constructs like ‘and/or’ and ‘he/she’ are technically not words, so you should avoid them as much as possible. This is a good approach, because it’s easy to rely too much on them even when there is really not logical need. Take for example, “You can call and/or write to request a free estimate”. There’s no real need to say ‘and/or’ in such a situation.
How would you rewrite the following to remove and replace non English words?
The 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 easily identify the noun that belongs to the pronoun. If more than one noun emerges as a possibility, replace the pronoun with its intended noun.
What’s rolling toward second base?
Helping verbs, also called auxiliary verbs, are tricky for two reasons: they can have multiple meanings and those meanings are sometimes a matter of interpretation.
EXAMPLE: “When you complete your timesheet, you should be paid.”
If you insert may instead of should, implies possibility or permission.
EXAMPLE: “When you complete your timesheet, you will be paid.”
Of all grammatical errors, misplaced and dangling modifiers cause the most hilartity. Let’s face it, they’re just plain fun (as long as it’s not you who writes them). In the words of Groucho Marx, “One morning I shot an elephant in my pajamas. How he got into my pajamas I’ll never know.”
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?
Unless you’re a time traveller (and therefore comfortable with temporal paradoxes), 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.
English has twelve tenses. Present tense is the only real tense—all the others are factors of our imagination, so don’t make time travellers of your readers by hiking around through your imaginary temporal landscapes.
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:
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.
Try writing the following sentences in the active voice.
EXAMPLE: To understand how to run for President of the United States, you must have friends in high places.
Using concrete specific words won’t necessarily make your writing shorter, but it will make it more interesting to read. Consider the following:
“A number of factors must be addressed to ensure this effort meets its objectives within the proposed time frame.”
Avoid:
And of course:
Rule: Use Concrete Specific Words
I also want to thank you for helping to make the process so easy and pleasant. It was great working with you.
From the beginning you had a very clear idea of how the site might be designed, but you were also more than willing to listen to my own ideas and suggestions.
Throughout I found the complete process, from starting with my initial request to taking delivery of your excellent final design a very positive and enjoyable experience.
I assure you I will not hesitate to recommend you to acquaintances and friends who may need the help of a website designer.
—Barry Cogswell, Visual Artist & Sculptor