TECHNICAL WRITING 1 GNET 2060

INTRODUCTION GNET 2060

Introduction College-educated employees spend a minimum of 20% of their time on the job writing. GNET 2060

Introduction Most college-educated workers rank the ability to write well as critically important to their job performance. GNET 2060

Introduction Technical writing produces: Proposals… GNET 2060

Introduction Brochures… GNET 2060

Introduction Sales literature… GNET 2060

Introduction Reports to stockholders… GNET 2060

Introduction Company memos… GNET 2060

Introduction Company reports… GNET 2060

Introduction Research reports, and… GNET 2060

Introduction Public relations releases. GNET 2060

Introduction Technical information goes: Superiors Superiors Colleagues Subordinates Subordinates Colleagues GNET 2060

Introduction If documents move in more than one direction, they may have to be drafted in more than one version. Superior You Colleague Subordinate GNET 2060

Introduction People working with technical documents need to learn: document design, standards for abbreviation, uses of tables and graphs. GNET 2060

DEFINITION OF TECHNICAL WRITING GNET 2060

Definition Technical writing is a specialty that requires: a working knowledge of technical subject matter, and… GNET 2060

Definition the arrangement and presentation of information that achieves the writer's purpose. GNET 2060

Definition Technical writing is clear, useful, and persuasive documentation. GNET 2060

DISCOVERY GNET 2060

Discovery Occurs in libraries… GNET 2060

Discovery laboratories, and… GNET 2060

Discovery the workplace. GNET 2060

LOCATING INFORMATION GNET 2060

Locating Information Most people selectively read online technical documents... GNET 2060

Locating Information Readers look for headings that match their needs and interests. GNET 2060

Locating Information Readers stop when a heading or graphic strikes them… GNET 2060

Locating Information Readers seldom read an online document from beginning to end. GNET 2060

Locating Information Page numbers are not useful for online documents unless the document is to be used for an oral presentation. GNET 2060

AUDIENCE ANALYSIS GNET 2060

Audience Analysis What is appropriate for your colleagues… GNET 2060

Audience Analysis …may be inappropriate for the general public. GNET 2060

POLYTETRAFLUOROETHYLENE Audience Analysis Terms are defined when your audience cannot be expected to know them. POLYTETRAFLUOROETHYLENE PTFE TEFLON GNET 2060

Audience Analysis Sentences can be fact filled when the audience is professional. GNET 2060

Audience Analysis However, when your audience does not share your profession, make your verbiage less dense. GNET 2060

SITUATIONAL ANALYSIS GNET 2060

Situational Analysis Brings a thought from nowhere to somewhere. GNET 2060

Situational Analysis May take 80 percent or more of the total project time. GNET 2060

RESEARCH GNET 2060

Research Employees record and transmit research via reports. GNET 2060

Research Students present their research through: laboratory reports… GNET 2060

Research tech briefs… GNET 2060

Research monographs, and/or… GNET 2060

Research theses. GNET 2060

EXAMPLES OF TECHNICAL WRITING GNET 2060

Examples A computer company prepares instructional manuals to accompany its computers. GNET 2060

Examples An architectural firm prepares progress reports to inform clients of the status of contracted building programs. GNET 2060

Examples A state department makes the public aware of natural resources. GNET 2060

Examples Agricultural extension services prepare and disseminate agricultural information. GNET 2060

Examples Companies use brochures to improve their public image and attract customers. GNET 2060

Examples Airlines, railroads, distributors of goods and services keep in the public view through: pamphlets, GNET 2060

Examples WWW sites, and… GNET 2060

Examples radio and television announcements. GNET 2060

Examples A technical paper on smoke detectors is used to determine their effectiveness in detecting: smoldering fires, flaming fires, and high temperatures. GNET 2060

GOOD TECHNICAL WRITING GNET 2060

QUALITIES OF GOOD TECHNICAL WRITING GNET 2060

Qualities Arrives by the date it is due… GNET 2060

Qualities Is well designed… GNET 2060

Qualities Makes a good impression… GNET 2060

Qualities Conveys an impression of authority, thoroughness, soundness. GNET 2060

Qualities Can be read selectively: summary, introduction, conclusions. GNET 2060

Qualities Can be read coherently and cumulatively from beginning to end. GNET 2060

Qualities Is free from: typographical errors… GNET 2060

Qualities grammatical mistakes, and… GNET 2060

Qualities misspelled words. GNET 2060

Qualities Sentences are highly specific and fact filled. GNET 2060

Qualities Provides essential information… GNET 2060

Qualities Is written clearly, without jargon… GNET 2060

Qualities Has a summary and/or conclusions. GNET 2060

Qualities Documents and credits sources through references and/or bibliographies… GNET 2060

Qualities Uses graphics to present and clarity content… GNET 2060

Qualities Answers readers' questions. GNET 2060

ARRANGEMENT GNET 2060

Arrangement Divide your subject into a series of sub- topics. GNET 2060

Arrangement Rough out a plan in a fairly complete outline... GNET 2060

Arrangement 95 percent of writers use an outline. GNET 2060

Arrangement Think about graphics while you are arranging your material. GNET 2060

Chronological Arrangement GNET 2060

Chronological Arrange events chronologically in a natural way. GNET 2060

Topical Arrangement GNET 2060

Topical The topic of Farming might be divided into sub-topics: Production and Marketing. GNET 2060

Topical Production sub-topic could be divided into: planting, maintaining, and harvesting. GNET 2060

ATTRIBUTES OF GOOD TECHNICAL WRITERS GNET 2060

Attributes Methodical and painstaking. GNET 2060

Attributes Do not squander their time and energy on minor tasks. GNET 2060

Attributes Record what they do and learn in a notebook or a computer journal. GNET 2060

ETHICAL CONSIDERATIONS GNET 2060

Ethics It is unethical and illegal to plagiarize! GNET 2060

EFFECTIVE PAGES AND SCREENS GNET 2060

Effectiveness Visually effective pages and computer screens are inviting... GNET 2060

Effectiveness Information is easy to locate. GNET 2060

Effectiveness Pages and screens have: space inside the text, GNET 2060

Effectiveness space around the graphics, GNET 2060

Effectiveness ample margins, and… GNET 2060

Effectiveness extra blank lines separating paragraphs. GNET 2060

CONCLUSION GNET 2060

Conclusion Remember: Clarity is your most important attribute GNET 2060

Conclusion Until the reader can understand what you write, nothing else can profitably be done with it. GNET 2060

GNET 2060