Thursday, April 17, 2008

The Ten Plagues of Technical Communication

Think your life is hard? Be glad your not a slave in ancient Egypt but avoid these plagues.

Wednesday, April 16, 2008

Thinking of hiring a tech writer? Check out these articles

I have links to three online articles over on my own blog.

If you have a bit of time, have a look at one or more of them and then leave a comment here on the STC Toronto blog telling us what you think -- or write your own blog post, if you've got plenty to say. I'd be particularly interested in opinions from anyone who has hiring experience.

The Rennie Charles Award

I did not know Rennie Charles, but from numerous accounts, he was a special person who gave a lot of himself to the STC Toronto chapter. A number of years ago, our chapter created an award in his memory and the cut-off date for recommendations for the award is 30th of April.

Please consider nominating someone from within our chapter - I can think of several candidates myself.

What qualities are needed in order to be recommended? Since I cannot improve upon the sentiments from the February 1998 article in Communication Times, I am having it republished here in a slightly edited form. It explains it all.

--by Sara Durning, Carla Salvador, and Kim Van Rooy

"Once again, we invite all members to make recommendations for the Rennie Charles Award.

It takes many dedicated and creative volunteers to make a chapter as strong and vigorous as the Toronto chapter, and every June we formally recognize those who have contributed to our growth and success during the previous 12 months.

For more than a decade, we have presented the Rennie Charles Award to one or, occasionally, two members who have made an “outstanding contribution” to the Toronto chapter in the current year or over the past several years. Every member is eligible for consideration, except those who have already won, and all members are welcome to make recommendations.

Rennie Charles is remembered by long-time STC members as a “dedicated leader and a good friend” and as a “sweet, delightful gentleman” who was cherished for the “ideas, support, patience, advice, and mirth” he shared with the Toronto technical writing community. He was twice the President of our chapter, an STC Associate Fellow, our director-sponsor, an STC board member, and a proud Canadian. Rennie was also one of the leaders who reenergized the Toronto chapter in 1985.

Rennie was known for constantly giving of himself to make things happen in the STC. If this reminds you of someone who has made an outstanding contribution to your STC experience, perhaps you could recommend them. Mention one or two specific reasons why you chose this person and submit your recommendation by April 30.

We will review all your suggestions and present a short list to the Toronto executive. The person or persons selected will be announced at the June meeting."

Tuesday, April 15, 2008

STC Volunteers Needed!

The STC Toronto Community would like to invite applications from all our members for positions as Activity Managers/Assistant Managers and Executive Team members and Assistants for the coming year. Members will need to be nominated or acclaimed for a position on the team.

If you want to take part in blazing a new course for our community, and in making a dynamic difference as a team member, please email the appropriate person in our STC Executive list or contact Sheldon D'Cunha at volunteering@stctoronto.org as soon as possible.

Monday, April 14, 2008

Review: Writing for the Internet

Author: Jane Dorner, Publsiher: Oxford University Press, ISBN: 0-19-866285-8

The book is divided into two parts: A and B. Part B is a quick summary of all the key ideas covered in part A. I liked that each chapter has its own contents list, which makes it a lot easier to jump to specific topics. Each page has a column allotted for an extra explanation of a topic or word, a summary of main points in the page, pointers, or quotes.

Introduction: The chapter explains briefly what Internet is about and how this book can help a reader understand what goes into it. I liked the section Reading routes where it explains to readers in a matrix format, how they can proceed in choosing topics based on what their role is or what they are looking for to achieve their goal. An explanation on various traditional roles in a non-Internet world and how they may merge when it comes to writing for the Internet is also useful to understand all that is involved for such a task.

Communicating online: The chapter introduces writing for Internet as a 'new art'. It explains the use of tone-of-voice and the practicality of emoticons for emails and gives few pointers on netiquette. I felt that the topics The Internet and the Web and Dominance of the Web should have been in the Introduction chapter rather than appearing so late into the book; these topics after emails and netiquette from my view didn't seem to fit here. Other topics include style, voice and readability. How technologies affect writing style on the right column of the Your Style topic gives a funny progressive view of how writing changed from the day of stone tablets to present day.

Internet publishing: The chapter talks about copyright, royalties and fees. A good foresight, having recently seen the strike by Writers' Guild of America. Some notable points were found in the point-wise explanation of differences between paper pages and web pages. I think that the acronyms created for BOOK and WEB are intuitive.

BOOK = Bound Optimally Ordered Knowledge

WEB = World Enabled Business

Considering purpose: The chapter explains about the various factors that need to be considered before creating a web page or a site. It emphasizes on the goals and benefits. I liked the four Ws concept (I prefer to remember it this way) or as the author states it, the Who-What-When-Where quartet. Other topics are Content, Audience, and Profile.

Planning: The chapter discusses the steps involved in any writing process i.e. the idea, the planning stage, the draft, and the editing. The planning here involves more with arranging web pages. The design and layout is explained further with topics such as page widths, page lengths, scrolling, etc. Also shedding light on collaborative writing and hints on the usefulness of having a file or a version control system when working in a team.

Good web writing: The chapter deals with some aspects of actual writing with elements related to a web page such as the use of white spaces, chunks, headings, and lists. Mostly has a list of do's and don'ts of word processing. I did learn something interesting in the section where the author talks about some types of writing such as the tadpole and the party game. At the end, it summarizes all that would work well for writing a web page. It is one of the three core chapters along with 4 and 6.

Web nuts and bolts: editing: The chapter emphasizes the importance of editing by a fresh set of eyes. It has pitfall topics such as dangling phrases, ambiguity, redundancy, unnecessary words, etc. A note on how punctuation actually appears on the web is provided.

The last two chapters Web genres and Keeping readers discuss various types of websites and what one can do to keep a reader engaged to a website. Shows some examples of a personal home page and a small company page.

In conclusion, I think that this is a reference book and has an easy to read format. If you are a writer solely doing the content and are in many ways not involved in the design and layout aspect of a web page, then you can skip a lot reading and jump into chapters 5 and 6 and Part B. But, on the other hand if you are someone who's planning to do some web design, layout, and writing then there's lot of helpful information available. Core chapters for this book are 4, 5, and 6. They deal with planning, writing, and editing.

All through the book, explanations are backed by charts and diagrams for additional support as needed; and it has few funny cartoons to keep it a light read. As suggested, the book does not deal with technical content except for some basic HTML code snippets and assumes that the reader is familiar with Internet in the sense that he or she has been online more than once and can navigate web pages.

For more about Jane, visit http://www.editor.net/.

Friday, April 4, 2008

Computer Classes for Seniors

From May 5-6, Christy Jackson will be delivering a course at Front Runner training for adults aged 55+ who are beginners at computers and want to learn more.

Location: Front Runner Training, Yonge & St. Clair

Cost: $10 per class, plus textbook for all four classes $15 (optional but recommended)

Course Description

Introduction to Computers - Monday, May 5th, 10am - Noon

For absolute beginners! Learn computer basics in a friendly, non-threatening environment.

The Internet & the Web - Monday, May 5th, 1pm - 3pm

Instruction and advice on surfing the World Wide Web.
Prerequisite: Introduction to Computers or equivalent skills.

Email for Beginners - Tuesday, May 6th, 10am - Noon

Everything you need to get started emailing your family & friends.
Prerequisite: Introduction to Computers or equivalent skills

Digital Photography - Tuesday, May 6th, 1pm - 3pm

Learn how to work with digital photographs on your computer.
Prerequisite: Introduction to Computers or equivalent skills

To register, please call Front Runner Training at:
416 515-0155.