Technical writing

TECHNICAL WRITING
Biotechnology Department, IMS Engineering College, Ghaziabad 1
Technical Communication
Presented by
Shomini Parashar
Assistant Professor, Biotechnology Department

 Define Communication
 Roles of Communication-General & Technical
 Technical writing
 Common types of technical writing
 Objectives of technical writing
 Process of technical writing
 Techniques for good technical writing
2
Technical Writing
Biotechnology Department, IMS Engineering College, Ghaziabad
Topics to be taken:

 Process of passing and understanding the information which
has been passed from one individual to another.
 It is the process of imparting ideas and making oneself
understood by others.
 It is a two way process of exchange of ideas and information
3
Technical Writing
Communication: verbal+ non-verbal


Increases interaction

Achieve organizational goals

Better human relations

Generations of better ideas

Better decision making

Timely updated with information
Biotechnology Department, IMS Engineering College, Ghaziabad 4
Roles of Communication:
Technical writing


Communicating about technology

Writing about technology

Writing about scientific subjects

Writing highly detailed information for specific audiences

Training people to use technology
5
Technical communication includes:
Technical Writing


Its important for students and professionals in all fields.

Technical communication is an art to explain technical
subjects to both technical and non-technical audiences.

Technical writing requires in-depth technical knowledge.

It is a challenging task as it requires precision and
accuracy and there is lot of scope of misinterpretation if it
is not written appropriately.
6
Technical writing: is it important?
Technical Writing

7
Common types of Technical Writing:
Technical Writing
Academic Writing Professional Writing

Project report/Lab
reports

Thesis/ Dissertation

Examination answers

Synopsis

Scientific articles

Research papers
Industrial report
Business proposals
Job applications/ Resumes
Notices/ Memos
Technical abstracts
Minutes of meetings


Writers

Editors

Web Designers

Graphic artists

Researchers

Developers- Informational, Instructional

Project Managers
8
Some examples of Technical Communicators:
Technical Writing


The main purpose of technical writing is to provide
sometimes complex technical information to technical and
non technical people.


This is the type of writing that will help people in
understanding any technical topic like computer algorithm
or a new drug or a new piece of technology etc.
9
Objectives of Technical writing:
Technical Writing


Determine purpose and audience

Collect information

Organize and outline information

Write the first draft

Revise and edit
10
Technical writing process:
Technical Writing


Audience type affects many aspects of communication, from word
selection and graphics use to style and organization.

Technical communicator must consider what qualities make a text useful

A non-technical audience might misunderstand or not even read a
document that is heavy with jargon— while a technical audience might
require details of the work. Busy audiences often don't have time to read
entire documents, so content must be organized in a way that ease the
searching of topics—for example by frequent headings, white space, and
other cues that guide attention.
11
Determining the purpose and audience:
Technical Writing


Technical communicators must collect all information
that each document requires.

It can be through primary (first-hand) research—or
secondary research, using information from existing
work by other authors.

Technical communicators must acknowledge all sources
which they use to produce their work.
12
Collect information:
Technical Writing


Before writing the initial draft, the technical communicator
organizes ideas in a way that makes the document flow well. Once
each idea is organized, the writer should organizes the document
as a whole in the following steps:

Decides the headings and subheadings, table of content etc…

After organizing the whole document, the writer typically creates a
final outline that shows the document structure.

Outlines make the writing process easier and save the author time.
13
Writing the first draft:
Technical Writing


The ABC (abstract, body, and conclusion) format can be used when
writing a first draft of some document types.

The abstract describes the subject, so that the reader knows what the
document covers.

The body is the majority of the document and covers topics in depth.

Lastly, the conclusion section restates the document's main topics.

The ABC format can also apply to individual paragraphs—beginning
with a topic sentence that states the paragraph's topic, followed by
the topic, and finally, a concluding sentence.
14
Writing the first draft:
Technical Writing


Once the initial draft is laid out, editing and revising can be
done to fine-tune the draft into a final copy.

It includes-

Adjusting and reorganizing content on topics that need
more attention, relocation of paragraphs, correction of
sentences, coherence of paragraph or entire topics,
grammatical errors etc.
15
Revising and Editing:
Technical Writing

Psychological condition of loosing the ability and enthusiasm to write due to
personal issues, financial or emotional crisis, criticism from peers, or
excessive work pressure.
The following measures may help prevent a writer’s block:

Think Positive- talk to good friends who boost your morale

Over look criticism

Take short breaks in between.

Read some other material not related to your writing.

Avoid excessive stress.
16
Techniques for good technical writing:
1. Overcome writer’s block
Technical Writing


Emphasis can be laid by changing the order of words in
the sentence or by changing the voice of the sentence. A
wrong positioning of words can change the meaning of
the sentence completely or result in ambiguity.

Passive voice can be used when the action is more
important than the doer. For example:

I am going to watch a movie today. ( Emphasis on ‘I’)

A movie is going to watched by me today. ( Emphasis on ‘a movie’)
17
2. Pay emphasis on writing:
Technical Writing


It is very important to balance the positive and negative factors while
conveying any message. The sentence has more emphasis if you have
positive tone in it as it conveys more information than the negative
sentence.

Positive sentences are motivating to read. Replacing words such as no,
never, impossible, cannot, etc. with try, efforts, and attempt. The following
example to find the difference between negative and positive

Negative : You are not writing this correctly .

Positive : If you practice you can write it correctly.
18
3. Focusing on positives:
Technical Writing


A technical writer has deadlines to achieve and
guidelines to abide by.

Hence, one needs to focus not only on writing
effectively but also on writing efficiently . This requires
organization of ideas and planning.
19
4. Prioritizing on effective and efficient writing:
Technical Writing


Plagiarism is copying another person’s ideas, words, or
work and pretending that they are your own. It is
considered an intellectually dishonest and highly
unprofessional act.

A technical writer, therefore, has to be aware of the rules
for citing direct quotes and acknowledge all the sources
referred to while developing the document.
20
5. Avoid Plagiarism:
Technical Writing

Technical writing

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à Technical writing

Similaire à Technical writing (20)

Dernier

Dernier (20)

Technical writing