Saturday, May 11, 2013

Working with Engineers (Part of the "Things to Expect" Series)

Good news and bad news

When it comes to the relationship between engineering and technical writing, there is good news and bad news.  First, the good news comes in a message of continuity – as long as there are products to be designed, companies will need engineers.  Similarly, as long as products are engineered, writing (status reports, white papers, presentations, product brochures, operations manuals, and much more) must support the products.  On the other side, the bad news seated in many engineers’ attitude of writing plagues may technical writers.
Neither of these issues are new.  In her 1990 article Engineering Writing/Writing Engineering, Dorothy Winsor reported on the existence of attitudes that I have encountered throughout my years of working with engineers.  Just as she observed, I have encountered engineers that have seen their job as only designing products – not writing reports or manuals.  Some engineers have pigeon-holed writing as “secretarial work.”  A few engineers have insisted on only providing short answers in personal interviews and data sheets as input to manuals and reports that I have written for them.
Although some of these engineers would never admit it, most of engineers would agree with Ms. Winsor’s assessment of engineers’ reliance on writing.  That is, “while … writing is not the final product, it is an essential means by which that product is created because it is the essential means by which engineering knowledge is created” (343).  These engineers would most likely also agree that the layout, writing style, and formatting used in many of their reports are based only on engineering department tradition that is only perpetuated in order to prove that the engineer is an engineer.  Therefore, the need for trained technical communicators who know to focus on the needs of the user should be painfully obvious.  Through the research of James Paradis as expressed in his Text and Action, it is.
Mr. Paradis discusses how task-oriented literature (user guides, operations manuals … ) must be used make technology useable by people.  As both positive and negative proof of this contention, he points out:
·         Some of the benefits of textual delivery of technical information.  For example, texts can deliver a cost-effective teacher/student ratio (p. 368, first paragraph) or break down complex events or objects (373).
·         A few of the drawbacks of poorly written instructions.  One such drawback occurs when the linearity of written instructions and the need to reduce complex situations results in the omissions, vagueness, and misunderstanding (368).  Another happens as technology becomes more complex and thereby forces the operationalization of human behavior.
·         The textual elements of object, agent, conditions, and action (367) used in task-oriented text.  As I mentioned in my first bullet, the use of action to break down complex events or objects (373) is a very effective tool of writers.  However, as Paradis points out, engineers often ignore this tool.  Therefore, this points to the need for technical writers.
·         Studies of two court cases centering on accidents involving stun guns.  The weaknesses in the manuals (produced as an afterthought by personnel whose primary role was not one of writing for the user) was found to be a major causal factor in the accidents.
Finally, Mr. Paradis observes that “in the legal context, operational discourse takes on the social and material consequences of liability” (375).  Similarly, I have considered how the greatest portion of my writing is used to protect my employer from lawsuits (for example, when I write manuals describing the safe operation of equipment).

Gloomy Good News

So technical writers can expect a good job forecast for the foreseeable future.  Also, before I finish this post sounding like glass-half-empty pessimist, I have to mention that there are indications that things are improving (and those indications will be discussed later).

References

Paradis, J. (1991). Text and action: The operator's manual in context and in court. Textual dynamics of the professions: Historical and contemporary studies of writing in professional communities, 256-278.
Winsor, D. A. (1990). Engineering writing/writing engineering. College Composition and Communication, 41(1), 58-70.

Sunday, May 5, 2013

Blogging into Technial Writing

Recently at the Society for Technical Communication group on LinkedIn, a member asked:
Hello, I am considering starting my own blog in hopes of landing a job in Tech Com. Any suggestions on how I should go about that at no cost? For those who have a blog, how has it helped your career? Thanks
At first, this seemed to go against the grain of what I had been taught about both blogging and technical writing.  In Content Rules:  How to Create Killer Blogs, Podcasts, Videos, ... , Handley and Chapman ask "Who are you?  What's unique about you?  What are your point of view and your perspective?"  (p. 21) when pointing the reader to defining himself or herself as a blogger.  Similarly, Macarthy suggests:
Solve Problems
One of the main reasons that people search the Internet is to find solutions to their problems, whether it be how to sew a button back on to their shirt, how to house train their dog, or how a guy makes himself irresistible to the opposite sex. Focusing on the solution to problems, especially for businesses, is a great way to come up with new ideas for blog posts and attract web traffic. Think about the problems that your customers want solving and use your expertise to tell them how they (or your business) can help. To go back to my dog example, a pet store owner might blog about the best way to stop your dog from barking, or how to teach it to sit or fetch. Think about how you can become an invaluable blogging resource for both your customers and those searching for solutions to their problems on the Internet.
Based on these quotes, it would seem that you would at least need to be an emerging expert on the topic before you started blogging.  Similarly, authors of technical writing textbooks have both sought to make technical communicators into experts on information delivery and have encouraged us to seek out the expertise of our subject matter experts (SMEs) (Rainey, Turner, Dayton 324).  Therefore, it does not seem that we should expect to turn both of these paradigms (that of blogging and of technical writing) on their heads.

The problem with this line of thought is that it assumes all bloggers are seeking a wide audience of people seeking our technical writing expertise.  However, the newbie blogger really is seeking to showcase his or her own technical writing skills to potential employers.  Rather than answering the questions of how to perform technical writing tasks, this blogger demonstrates how they have a mastery of the technical writing tool.

Therefore, it seems best to encourage all new and aspiring technical writers to blog.

References

Handley, A., & Chapman, C. C. (2012). Content rules: how to create killer blogs, podcasts, videos, ebooks, webinars (and more) that engage customers and ignite your business (Vol. 13). John Wiley & Sons.

Macarthy, A. (2012). 500 Social Media Marketing Tips: Essential Advice, Hints and Strategy for Business: Facebook, Twitter, Pinterest, Google+, YouTube, Instagram, LinkedIn, and More! Kindle Edition.

Rainey, K.T., Turner, R.K., & Dayton, D. (2005).  Do curricula correspond to managerial expectations: Core competencies for technical communicators. Technical Communication, 52, 323–352.