Technical Writing

TheJJacademy.com

IntroductionPurposesImportanceCharacteristicsTechnical Writing VS Academic WritingTechnical Writing VS Imaginative Writing

Contents

TheJJacademy.com

o Technical writing is a communication written for specific purpose in a technical field or profession.

o Technical writing is a type of writing where the author is writing about a particular subject for giving direction, instruction, or explanation. 

Definitions

TheJJacademy.com

Technical writing conveys specific information about a technical subject to a specific audience for a specific purpose.

The words and graphics of technical writing are meant to be practical: that is, to communicate a body of factual information that will help an audience understand a subject or carry out a task.”

Intro…

TheJJacademy.com

Technical writing is writing done in the workplace, although the workplace may be an office, a construction site, or a kitchen table.

Technical writing is a field of professional writing on technical subjects.

Intro…

TheJJacademy.com

Business Writing Workplace Writing Professional Writing Informational Writing

Other Related Names…

TheJJacademy.com

Examples are:

• Reports• Computer Hardware Guides• Newsletters•Organizational Manuals• Software Guides• Technical Reports• CV (Curriculum Vitae)• Job Letters• Job Applications

TheJJacademy.com

Directions on the toothpaste tube Nutrition benefits on the cereal box Business letters and catalogs that come

in the mail Written instructions for a new product Tax receipts and notices Product safety information

Common Examples

TheJJacademy.com

To inform (on using products) To Complete a task Operating equipment To persuade To assist To Guide To report To communicate To inquire To demand

Purposes

TheJJacademy.com

1. In many different types of work, writing constitutes an important part of the everyday workload.

In a company, project or activity, decision-making, to communicate within the organization, to ask questions …

email messages (progress reports), (recommendation reports), (inquiry letters), (memos),

Importance

TheJJacademy.com

2. To facilitate communication with co-workers, clients and supervisors, that is, inside and outside the workplace.

It is not enough to be technically good, but skillful in communicating is also necessary.

To convince others of the importance of the work…

TheJJacademy.com

Organizations know the advantages of a well written document since the way they construct their documents reflects their image.

E.g. applicants’ CV in a job selection process…

3. Necessary for a successful career.

TheJJacademy.com

Writing skills contribute to saving time and money.

If you create a document, a report, for example, for your superior, which is clear and easy to understand, no time will be wasted on pondering the meaning.

4. Writing skills contribute to saving time and money.

TheJJacademy.com

The four C’s:• Clarity -- it is easily understood by your intended

audience• Comprehensiveness -- all of the necessary

information is present• Conciseness -- it is clear without excessive

wording.• Correctness -- it is grammatical and follows

conventions or rules.

Characteristics

TheJJacademy.com

Audience: carefully considered, targeted

Organization: predictable, apparent

Style: concise, direct, specialized vocabulary

Tone: objective, businesslike Special features: visual elements

Characteristics

TheJJacademy.com

As a Tech Writer you have to… Determine the needs of the audience Organize the structure of technical

documents Write information that meets the needs of the

audience Write so that users can easily find and

understand information

TheJJacademy.com

The writing conveys technical, complex, or specialized information in a way that is easy for a non-technical reader to understand. (In some cases e.g. us of mobile phone)

If the document is related to a specific field e.g. medical or engineering, then use field specific register.

Use page elements such as tables, lists, and headings appropriately (in the case of reports)

Edit and proofread (read for errors) to produce documents without grammar or typographical errors.

TheJJacademy.com

Both must be unified, coherent, and well organized.

Style and standard usage are important in academic and technical writing.

But….

Technical Writing VS Academic Writing

TheJJacademy.com

The difference between academic writing and technical writing is in the presentation, audience, and approach.

Academic writing is written for an academic audience—an instructor, classmates, or a group of interested scholars.

The purpose of academic writing is to expand on an idea or make observations about human experience.

Technical Writing VS Academic Writing

TheJJacademy.com

Technical writing is written for a specific audience.

The subject is generally technical, professional, business-related, or scientifically oriented.

Technical Writing VS Academic Writing

TheJJacademy.com

Purpose:

Knowledge of Topic:

Audience:

Criteria for Evaluation:

Academic Demonstrate

what you know about a topic

Less than teacher who is evaluating them

Teacher/ student

Depth, logic, clarity, unity and grammar

Technical Writing VS Academic Writing

TechnicalGetting something done

More than the reader

Several People

Clear and simple organization of ideas

TheJJacademy.com

Imaginative: ◦ Creative, ambiguous, fantasy , different

interpretations.

Technical: unambiguous, direct, clear

Technical Writing VS Imaginative Writing

TheJJacademy.com

Creative Writing: Expressive, imagery, fiction, connotative meaning. Examples: novel, drama, poem

Expressive writing: essays and informal letters. Subjective, connotative meaning

Expository writing: comparison and contrast, analyses, argumentation. Connotative and denotative meanings.

Journalism: Newspaper etc. Objective. Facts..

Note

TheJJacademy.com

TheJJacademy.com

Thanks TO Join UsTheJJacademy.comThanks TO Join UsTheJJacademy.com

TheJJacademy.com