0% found this document useful (0 votes)
317 views5 pages

Notes-Chapter 1

Technical communication involves conveying technical information to specific audiences through various media like documents, webpages, and audio/visual content. Technical communicators tailor information for subject matter experts, consumers, end users, and ensure it is accurate and understandable. Successful technical writing is clear, concise and complete - using straightforward language without jargon. It follows standard formats and considers the three Cs - is the content clear, concise and complete? Technical documents must effectively meet the needs of the intended audience.

Uploaded by

Echa Lassim
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
317 views5 pages

Notes-Chapter 1

Technical communication involves conveying technical information to specific audiences through various media like documents, webpages, and audio/visual content. Technical communicators tailor information for subject matter experts, consumers, end users, and ensure it is accurate and understandable. Successful technical writing is clear, concise and complete - using straightforward language without jargon. It follows standard formats and considers the three Cs - is the content clear, concise and complete? Technical documents must effectively meet the needs of the intended audience.

Uploaded by

Echa Lassim
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 5

COMMUNICATION Communication (from Latin "communis", meaning to share) is the activity of conveying information through the exchange of thoughts,

messages, or information, as by speech, visuals, signals, writing, or behavior. Communication requires a sender, a message, and a recipient, although the receiver need not be present or aware of the sender s intent to communicate at the time of communication! thus communication can occur across vast distances in time and space. Communication requires that the communicating parties share an area of communicative commonality. "he communication process is complete once the receiver has understood the message of the sender.

TECHNICAL COMMUNICATION Technical communication is a set of methods that practitioners use to research and document technical processes or products. "echnical communicators (technical writers, technical illustrators, information architects, etc.) may put the information they capture into paper documents, e! pa"es, di"itally stored te#t, audio, $ideo, and other media. Technical communicators "enerally tailor information to a specific audience, hich may !e su!%ect matter e#perts, consumers, end users, etc. "echnical communicators often wor# collaboratively to create deliverables for various media. $eliverables include online help, user manuals, technical manuals, white papers, specifications, process and procedure manuals, industrial videos, reference cards, data sheets, %ournal articles, patents, training, business papers, technical reports, and forms and documents.

The differences between Academic Writing and Technical Writing Aspects


Purpose

Academic Writing
To present the results of one's knowledge, To present the results gained from one's personal research, To present one's point of view.

Technical Writing
To teach someone how to use a specific product or service To describe the procedures that are employed by companies for carrying out various tasks.

Audience

Fellow scholars, and often, depending on the journal or publication, to the general public.

The user of the product or the service, or to government inspectors who need to see how the company carries out certain tasks and also the public users.

Mechanics (correctness)

Correct spelling, punctuation, grammar

Correct spelling, punctuation, and grammar

important, but not critical unless errors interfere with meaning or unless document will be submitted for publication.

ormat

oom for fle!ibility. ".g Manuscript format can change from instructor to instructor or from academic publisher to academic publisher. $sually somewhat formal, high le%el of %ocabulary. !entences are combination of short, medium and long. "aragraphs can be very long and are indented. "assive voice is avoided, but is sometimes necessary.

Writing #tyle

Content

$enerally, ideas are meticulously and e!tensi%ely discussed and analy(ed. $ses descripti%e and metaphoric language. (n researched writing, points are supported with outside supporting material, which is carefully cited and documented. )anguage can be either or both concrete and abstract.

absolutely crucial because writing represents a business or company and may affect its reputation. Errors signal carelessness or lack of attention to detail. Errors that affect meaning could also lead to liability issues. Many business and technical formats (e.g., memo, business letter, proposal, lab reports, research reports, etc.) remain fairly static and consistent. &ocabulary is clear and understandable to a wide audience of both e!perts and non'e!perts. Technical terms are avoided, unless audience is well#versed in topic. Medium le%el of formalitycommunication products should be friendly and approachable, but not intimate. $enerally, tone is positive and direct. %ostly avoids clich&s. !entences tend to be short and medium. "aragraphs also tend to be short with e'tra spacerather than indentationsignaling paragraph break. Tendency to use subheadings, and bulleted and numbered lists. "assive voice preferred in scientific writing. )deas e!pressed concisely, clearly, and directly* a%oiding unnecessary description or e!planations. Transitions are clear and logic'based (e.g., while, although, because, if, but, first, second, third, therefore, in conclusion, finally). *lear and concise introductions and conclusions. (ntroductions clearly spell out the purpose of the document. (deas e'pressed in concrete, +,T vague or abstract language. *onclusions sum up the points made in the documents. ,rgani-ation generally dictated by format conventions .e.g., memo, proposal,

+rganisation

,rgani-ation generally dictated by genre e'pectations .e.g., argument,

rhetorical analysis, narrative, comparison/contrast, definition0. !tyle format .e.g.,, 1"10 may dictate organi-ation of parts of the whole document .e.g2 cover page, te't, end notes, work cited, appendi'.

business letter, lab reports, articles, research reports0 or by organi-ational conventions, which may be described in an organi-ational style manual.

The oundations of an "ffecti%e Technical Writing 3now your reader ,.3now your objective 4e simple, direct, and concise 3now the conte't in which your communication will be received and used The .ualities of /ood Technical Writing E'emplifies effective design5 makes a good impression. (s designed so that it can be read selectively. 6as a rational and understandable plan. (s coherent throughout. 1nswers readers7 8uestions as they arise in the readers7 minds. 6as the necessary introduction to characteri-e the report and reveals its purpose and scope. 6as a body that provides essential information and that is written clearly without jargon. 9hen appropriate, uses tables and graphs to present and clarify its content 6as, when needed, a summary or set of conclusions to reveal the results obtained. *onveys an impression of authority, thoroughness, soundness, and honest work. *an stand alone and be understood by readers who are not part of the initial audience. %akes a positive statement about the writer and the organi-ation.

(s free from typographical errors, grammatical slips, and misspelled words.

"!amples of Technical documents :efinition "roject proposal 4usiness and sales report 4rochure )ab report %anual and instructions "rocess essay ;uestionnaire 1rgumentative essay 4usiness letters esume Field Trip eport Technical description *ase study report "roposal 1ccident eport

:escriptive essay 1cademic "roject eport Flyers 1dvertisement

Tips #uccessful Technical Writing When carrying out a technical writing assignment, you must remember to follow what is known as the three Cs and ask yourself the following questions: (s it clear< (s it concise< (s it complete<

Clear and unambiguous language

A%oid too full of technical language

A%oid technical 0argon and terminology,

#traight to the point

Clear message

Summary of tips for successful technical document writing

You might also like