Technical and Professional Writing Commons^™

22. Graphics, David Mcmurray

Sexy Technical Communications

One of the nice things about technical writing courses is that most of the papers have graphics in them—or at least they should. A lot of professional, technical writing contains graphics—drawings, diagrams, photographs, illustrations of all sorts, tables, pie charts, bar charts, line graphs, flow charts, and so on. Once you get the hang of putting graphics like these into your writing, you should consider yourself obligated to use graphics whenever the situation naturally would call for them. Unlike what you might fear, producing graphics is not such a terrible task—in fact, it's fun. You don't have to be a …

27. Articulating Technical Information, David Mcmurray, Jonathan Arnett, Tamara Powell

Sexy Technical Communications

The ability to explain complex, technical matters with ease, grace, and simplicity so that nonspecialist readers understand almost effortlessly is one of the most important skills you can develop as a technical writer. This ability to "translate" or articulate difficult-to-read technical discussions is important because so much of technical writing is aimed at nonspecialist audiences. These audiences include important people such as supervisors, executives, investors, financial officers, government officials, and, of course, customers. This chapter provides you with some strategies for articulating technical discussions, that is, specific strategies you can use to make difficult technical discussions easier for nonspecialist readers …

33. Strategies For Peer-Reviewing And Team-Writing, David Mcmurray

Sexy Technical Communications

Peer reviewing (also called peer-editing) means people getting together to read, comment on, and recommend improvements on each other's work. Peer-reviewing is a good way to become a better writer because it provides experience in looking critically at writing. Team writing, as its name indicates, means people getting together to plan, write, and revise writing projects as a group, or team. Another name for this practice is collaborative writing—collaborative writing that is out in the open rather than under cover (where it is known as plagiarism).

37. Logic: Recognizing Fallacies, Steve Miller, Cherie Miller

Sexy Technical Communications

I often read comments on blog posts or articles or Facebook discussions which accuse the writer of committing a specific logical fallacy and thus declaring the argument thoroughly debunked, typically with an air of arrogant finality. While the debunker may feel quite smug, intelligent participants consider him quite sophomoric.*text annotation indicator In reality, he's typically failed to even remotely understand the argument, much less apply the fallacy in a way that's relevant to the discussion. Surely this fallacy deserves a proper name and should be listed with other fallacies. Thus I'll define "The Fallacy Fallacy" as "Improperly connecting a fallacy …

38. Usability Testing, Cassandra Race

Sexy Technical Communications

I will never forget a Christmas Eve many years ago, when the kids were finally asleep and Mr. and Mrs. Santa Claus began the assembly of the much desired "brand name" doll house. Out came the tools, out came a hundred or so tiny plastic parts, and out came an instruction sheet written by someone clearly from another land far away. After several hours of attempting to decipher some of the worst instructions ever written, we recruited a neighbor's 12 year old, a seasoned veteran in the world of dream houses, and the assembly was completed in time for Christmas …

41. Introduction To Html, Tiffani Reardon

Sexy Technical Communications

At the end of this chapter and the practice activities, readers will be able to: Goal 1: define HTML and identify what it stands for Goal 2: build a simple web page using HTML coding Objective 1: identify and use common HTML tags Objective 2: explain and apply basic tag rules Objective 3: explain attributes and use them to stylize text and images Objective 4: embed videos and other embeddable items into HTML web pages Goal 3: identify websites where readers can learn more and practice their HTML skills

42. Standard Operating Policies And Procedures, David Mcmurray, Tamara Powell

Sexy Technical Communications

This chapter introduces you to policies and procedure documents and to standard operating procedure documents. Click on the links, below, to see samples.

Hand-washing policies for health care personnel

Accounting policies and procedures

Standard operating procedures: pouring dental impressions

1. Introduction: The Nature Of Sexy Technical Writing, Cassandra Race

Sexy Technical Communications

Did you know that you probably read or create technical communication every day without even realizing it? If you noticed signs on your way to work, checked the calories on the cereal box, emailed your professor to request a recommendation or followed instructions to make a withdrawal from an ATM, you have been involved with technical, workplace, or professional communication. So what? You ask. Today, writing is a more important skill for professionals than ever before. The National Commission on Writing for Americas Families, Schools, and Colleges (2004) declares that writing today is not a frill for the few, but …

4. Business Plans, David Mcmurray

Sexy Technical Communications

A business plan is a document used to start a new business or get funding for a business that is changing in some significant way. Business plans are important documents for business partners who need to agree upon their plans, government officials who need to approve that plan, and of course potential investors such as banks or private individuals who may fund the business. A business plan is very much like a proposal, except for at least one big difference. The business plan seeks to start a new business or significantly expand an existing business. A proposal, on the other …

7. Writing Instructions, David Mcmurray, Jonathan Arnett

Sexy Technical Communications

The focus for this chapter is one of the most important of all uses of technical writing—instructions. As you know, instructions are those step-by-step explanations of how to do something: how to build, operate, repair, or maintain things. When you finish this chapter you will be able to: Analyze and evaluate a set of technical instructions Write clear and accurate instructions with an introduction and conclusion Develop and design an instruction manual for a specific audience

9. Standard Operating Policies And Procedures, David Mcmurray

Sexy Technical Communications

This chapter introduces you to policies and procedure documents and to standard operating procedure documents. Click on the links, below, to see samples. Hand-washing policies for health care personnel Accounting policies and procedures Standard operating procedures: pouring dental impressions (Thanks to Melissa Burke for making this SOP available.)

12. Titles, Abstracts, Introductions, Conclusions, David Mcmurray

Sexy Technical Communications

Formal technical reports over eight to ten pages contain several components that deserve their own focus because they are important in technical reports and because people are unfamiliar with them: Titles explores strategies for making document titles specific but not paragraphs long. Abstracts provide several kinds of summaries of the report contents and conclusions. Introductions get readers ready to read reports by indicating the topic, purpose, intended audience, contents, and orther such matters. Conclusions shape how readers view and understand the report upon leaving it.

15. Report Design, David Mcmurray, Jonathan Arnett

Sexy Technical Communications

Technical reports (including handbooks and guides) have various designs depending on the industry, profession, or organization. This chapter shows you one traditional design. If you are taking a technical writing course, make sure the design presented in this chapter is acceptable. The same is true if you are writing a technical report in a science, business, or government context. Technical reports have specifications as do any other kind of project. Specifications for reports involve layout, organization and content, format of headings and lists, the design of the graphics, and so on. The advantage of a required structure and format for …

23. Help Desk: Creating An Index, Cassandra Race

Sexy Technical Communications

In long technical documents, an index, or a list of almost everything in the document, is found at the end of the document. The index is a helpful tool for quickly locating information, and many readers expect it. There are several techniques for creating an index, but the most efficient and up to date is right at your fingertips. Microsoft Word allows you to create an index for a single word, a phrase, or even a symbol. You can also create an index item for a topic that covers several pages or paragraphs, or one that refers to another entry, …

24. Writing Process: From Audience To Rough Draft, David Mcmurray

Sexy Technical Communications

The writing process takes you from the very beginning of a writing project—finding topics and analyzing audience and purpose—all the way to the end—writing and revising the rough draft. The following chapters focus on some of the key phases of that process: Strategies for team-writing Audience Analysis Brainstorming and invention Narrowing Outlining Note-taking Libraries, Documentation, Cross-Referencing Strategies for Peer-Reviewing Power-Revision Techniques

25. Audience Analysis, David Mcmurray

Sexy Technical Communications

The audience of a technical report—or any piece of writing for that matter—is the intended or potential reader or readers. For most technical writers, this is the most important consideration in planning, writing, and reviewing a document. You "adapt" your writing to meet the needs, interests, and background of the readers who will be reading your writing. The principle seems absurdly simple and obvious. It's much the same as telling someone, "Talk so the person in front of you can understand what you're saying." It's like saying, "Don't talk rocket science to your six-year-old." Do we need a course in …

30. Basic Patterns And Elements Of The Sentence, David Mcmurray

Sexy Technical Communications

This section is a quick review of the fundamentals of the sentence. If you encounter unfamiliar terminology in this textbook or in your class, refer to this section for help. For more on sentence grammar, see English Fundamentals by Emery, Kierzek, and Lindblom (Macmillan) for a thorough discussion of sentence grammar, along with exercises.

32. Common Spelling Problems, David Mcmurray, Tiffani Reardon

Sexy Technical Communications

For some writers, their main spelling problem is similar-sounding words, for example, principle and principal or affect and effect. These problems cannot be flagged by software spell-checking functions. Here is a list of these commonly confused homophones (different spelling; same or very similar pronunciation), with examples of their correct use. All definitions in this section are from the Merriam Webster dictionary via the Merriam Webster Dictionary mobile application.

35. Logic: Common Fallacies, Steve Miller, Cherie Miller

Sexy Technical Communications

In the last chapter we discussed passages where bright individuals with PhDs violated common fallacies. Even the brightest among us fall for them. As a result, we should be ever vigilant to keep our critical guard up, looking for fallacious reasoning in lectures, reading, viewing, and especially in our own writing. None of us are immune to falling for fallacies. Until doctors come up with an inoculation against fallacies, I suppose the next best thing is to thoroughly acquaint ourselves with the most common fallacies. I chose the following fallacies by comparing a dozen or so university sites that list …

36. Logic: How To Do It Wrong, Steve Miller, Cherie Miller

Sexy Technical Communications

To the mind that's yet to be "enhanced" by some strains of modern thought, the above quote probably comes across as amusing, but useless. After all, who would deny something as basic as the law of non-contradiction or the basic laws of logic? If saying "My roommate annoys me" is no different than saying "My roommate doesn't annoy me," then how can we ever say anything meaningful? Moreover, the very act of denying non-contradiction assumes the law to be true. Yet, some argue that our brains, like our opposable thumbs and other body parts, evolved not to perfect our logic, …