Shoap Technical ServicesBuzzwords are just like bad pop stars: they appear mysteriously, gain fans like the plague spreads, and seemingly vanish; yet new ones are constantly appearing. Why do we continuously go through this cycle?
STS has banned buzzwords. I learned quickly that even saying “buzzword” meant trouble—someone would be on a rant soon. So I made a list of the most-abused words with suggested alternatives. I hope I haven’t just created the new lingo.
There are certain standard practices in font choice that have become so ingrained that many of us now scarcely consider the alternatives. Writing a paper? Times New Roman. Building a website? Arial. Creating an invitation? Coronet. It seems obvious, almost innate, that printed texts should be written in serif fonts; that digital media should be written in sans serif fonts. But when should these standards practices be broken? When should boundaries be pushed?
Excitement and innovation aren’t really words that come to mind when you think of “technical writing,” right?
I didn’t think so. As interesting as the profession can be, we often find ourselves filling in the same template for the same type of document over and over again. And while it’s important to make clients happy and follow the standard formats, we must always keep sight of our goals – does our documentation serve its purpose? Does it teach? Does it explain? Does it do these things well?
I did not like change.
Last Monday I began a major new chapter: my internship at Shoap Technical Services. I was hired to do marketing for the summer and given a great deal of freedom. I was encouraged to let my mind run free and to tackle any project I thought I would enjoy doing to increase sales. It’s an aspiring PR girl’s dream. But like I said, I didn’t like change.
I recently completed a project to create a document defining the types of functionality and relationships associated with the various database columns and tables in the back-end of a client’s medical billing software. While the project was fun (at least in the sense that I got to work on something nerdy and technical), it was also a sobering reminder about the uncertainty endemic to the world of consulting.
Recently, I’ve been attending lots and lots of meetings. I like talking to people, learning, brainstorming, smiling, etc. One thing that has been pretty consistent though is that people are not doing their “homework”. Teachers didn’t talk about the importance of homework in our 17+ years of schooling for nothing.
As technical writers, we at Shoap Technical Services feel strongly about words. We feel they hold more power when chosen carefully and used with purpose. We pride ourselves on only writing as much as needed to accurately convey a message, without allowing room for waste.
That’s why we reserve a very special type of hatred for one of those semi-universal annoyances of modern business culture: the e-mail footer disclaimer. It should come as no surprise, then, that we took great pleasure in reading this Economist article explaining exactly how pointless these are. It all boils down to the fact that most of these disclaimers are unenforceable since they seek to impose contractual obligations in a unilateral way.
So please, please, save your bandwidth and mine. Kill the disclaimers.
Recently I’ve been thinking about the different ways we organize our content when we create a document. Most of ours have the usual Table of Contents and Index. Some even have a table of Figures. I’ve even put together the odd document where we’ve been asked to include a Table of Database Entities referencing all queries where a given table was used.
Over at I’d Rather Be Writing, Tom explores some of the interesting ways that content is referenced in a hymnbook (for example, by meter for organists) and suggests a few more value-added ways to list the book’s contents.
Have you ever come up with a novel way of breaking down a documents contents?
If you’re located in the greater Atlanta area and interested in technical writing, instructional design and related fields, you might want to stop by Kennesaw State University on April 14. KSU will be hosting a free workshop on 21st-Century Trends in Publishing and Researching in Writing Studies, followed by a Q+A session on publishing processes for scholarly publications.
Both the workshop and Q+A session will be led by technical writing expert Dr. Amy Koerber, editor of the Technical Communications Quarterly journal and associate professor of Technical Communication and Rhetoric in the English Department at Texas Tech University.
Registration is encouraged! For more information, check out the Georgia Writer’s Association event page at http://events.r20.constantcontact.com/register/event?llr=i6byw7bab&oeidk=a07e3kmu416e936eea6
In technical writing (as well as other areas of life), having a smartphone on me has saved my butt on more than one occasion, and not just for looking up directions to a client site or doing some quick on-the-spot research on some byzantine technical topic that I need to understand.