17

Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Embed Size (px)

Citation preview

Page 1: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,
Page 2: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Definition:

Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing, explaining, or documenting.

Some types of business writing are letters, memoranda, and reports.

Technical documents include reports, manuals, and instructions.

Page 3: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

History:Technical writing has existed for all of

recorded history. Consider Leonardo da Vinci’s drawings and notes, as well as writing by Isaac Newton and other scientists.

Page 4: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

For centuries only other scientists or university students read these texts. However, as literacy increased and the Industrial Revolution brought more complex machines, the need for more technical writing for a larger audience grew.

Page 5: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Technical communication increased greatly during World War II, with more sophisticated weaponry and advancements in transmitting communication.

The U. S. Army trained communications specialists at Camp Gordon, now Fort Gordon, outside Augusta, Georgia.

Page 6: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Since the 1960’s technical writing has surged in the field of computer technology. Today readers are flooded with technical information in many forms—from owners’ manuals for cars, to instructions for installing a computer game system.

Page 7: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Characteristics:

Good technical writing conveys ideas “with the

goal of expressing, not impressing.”

Audience awareness: Readers’ needs are most important. The writer must convey information in a manner that readers will understand.

Page 8: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Clarity: Writers create concise sentences and use active language. Sentences become like airline baggage, with writers carrying only what is

necessary. Strong, active verbs add interest and understanding.

Page 9: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

• Conciseness: Good technical writers express ideas as briefly as possible, avoiding redundancies, clichés, vagueness, unfamiliar jargon, and “gobbledygook.”

Example:

“Gobbledygook: In the event of life-threatening conflagration, expeditiously transport your person through the indicated egress of closest proximity to your location.”

Page 10: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

“Translation: In case of fire, quickly leave through the nearest door marked ‘EXIT.’”

Page 11: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Process:

Technical writers follow the same steps as other writers.

• Prewriting: Consider the audience and purpose. Common purposes are defining, describing, and instructing. Gather and organize information.

• Drafting: Write ideas as concisely and clearly as possible.

• Revising: Check for concerns such as verb choice, clichés, or other poor wording.

Page 12: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

• Editing: Correct errors in punctuation, spelling, and mechanics.

• Presenting: Create text that looks professional by allowing for adequate white space, using headings and subheadings, presenting lists, including illustrations (drawings, tables, graphs, charts, photo- graphs, etc.), and providing appendixes.

Page 13: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Forms:

• Memorandum (Memo): This brief, informal report communicates information within an organization. It includes a four-part heading, a statement of purpose, background information, brief discussion, conclusions, and recommendations. These texts often explore feasibility of a new process or product, make proposals, report progress, or provide troubleshooting information.

Page 14: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

• Formal Report: The writer develops a document which follows a structured format that may include a “title page, table of contents, executive summary, body with headings, conclusions, recommendations, references, bibliography, appendixes, glossary, and index.”

Page 15: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

• Proposal: The writer’s purpose is to sell a product, service, or idea. Such a document often includes a “cover letter, table of contents, executive summary, proposed program, company background, budget, and appendixes.”

• Manual: The document explains a process or the use and maintenance of a mechanical device.

Page 16: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

• Journal Article: A writer presents information from his occupational field to a journal which professional colleagues read.

Page 17: Definition: Most business and all technical writing communicates specific, factual information to a defined audience for the purpose of informing, instructing,

Source: Shelton, James H. Handbook for Technical Writing. Lincolnwood, Illinois: NTC Business Books, 1996.