Differences Between Different Guides

Introduction Some of my readers asked the differences between three types of technical documents used frequently in the software-hardware sector: User Guide,  Startup Guide, and Quick Reference Guide. Sometimes the demarcation line gets blurred, especially if you’re new in the business. User Guide A USER GUIDE is the easiest to define: it’s the “bible” of…

Read More

Short Interviews with 2 New STC Members

The first new STC (Society for Technical Communication) member for 2010 is David Cochrane, who is starting a technical writing company in the Toronto, Ontario, Canada area. The first to renew was Dan Block, a longtime member from western New York State. Let’s see what they had to say! David Cochrane How did you first hear…

Read More

Technical Translation — Is It in Your Future?

© 2009-2010 Ugur Akinci Have you ever considered to become a “technical translator”? That is, a technical communicator who translates technical documents and manuals from one language to another? If you can read and write well in more languages than one you should really consider this niche since technical communication has become a worldwide phenomenon.…

Read More
Technical Writing Jobs

10 Non-Hi-Tech Writing Jobs for Technical Communicators

Introduction: Technical Writing Jobs “Technical” is an interesting qualifier in the technical communication field since not all “technical writing jobs” are technology and hi-tech related. Here are 10 non-hi-tech writing jobs for technical communicators for those who are hunting for a job: Writing Office Manuals Write a manual describing how to use the various office…

Read More

Bad Technical Writing Can Lead to Disaster

  Here is a memo (part of the public record) that some people think probably contributed to one of the worst nuclear plant accidents in history: ———————————– (START) BABCOCK & WILCOX COMPANY I R GENERATION GROUP August 3, 1978 TO: Manager, Plant Integration FROM: Manager, Plant Performance Services SUBJECT: Operator Interruption of High Pressure Injection…

Read More

CNN: Technical Writing is the 28th Best Job in America

A CNN survey of 50 TOP JOBS concluded that Technical Writing is one of the best jobs in America today — 28th best job, to be exact. What’s more than that, the CNN survey also concluded that, in terms of “Quality of Life” and low-stress working conditions, Technical Writing ranks 5th in the USA. Technical…

Read More

An Interview About Technical Writing

(Excerpts from an excellent interview by Tom Johnson) How did you make the career transition from academia and teaching to technical writing? I taught basic writing courses to university students at The American University in Cairo for a couple of years. I also taught composition as a graduate student at Columbia for two years. Teaching…

Read More

How Reliable is Your “Reference Data”?

Before the Crisis of 2008 hit, main mortgage brokers on the Wall Street were confident of the way they were running their business. Their software programs were written by crackerjack developers from top Ivy League schools. When they fed their sub-prime lending numbers into these programs, the result was “positive.” After a year of monitoring,…

Read More
Quality Control Plan

How to Write a Quality Control Plan (QCP) — Part 1

Introduction Quality Control Plan (QCP) is an important document for those hoping to secure a U.S. government contract. A quality control plan is a document that ensures the safety and accuracy of a product. Quality control plans can be applied to any type of project, from building houses to developing new software. A quality control…

Read More