Technical Report Writing-ME-303

Technical Report Writing-ME-303

Arshad Mehmood

Department Of Mechanical Engineering Peshawar Campus

March 9, 2023

1 / 24
Technical Report Writing-ME-303

Course Contents

Introduction to Technical Report writing.

7C’s of communication and Resume writing.
Technical report writing process.
Writing styles.
Research proposals.
Research/Term papers.
Feasibility report.
Plagiarism and use of citation management software.

2 / 24
Technical Report Writing-ME-303

Recommended Books

3 / 24
Technical Report Writing-ME-303

CLOs and PLOs

4 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

5 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

5 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

Newspapers.

5 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

Newspapers.

5 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

Magazines.

Newspapers.

5 / 24
Technical Report Writing-ME-303

Different forms of writing

General Novels.

Magazines.

Newspapers.

5 / 24
Technical Report Writing-ME-303

Journal Article Writing

6 / 24
Technical Report Writing-ME-303

Journal Article Writing

6 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing has many names – practical, informational,

workplace, professional, business or transactional writing.

7 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing has many names – practical, informational,

workplace, professional, business or transactional writing.
Technical writing is the presentation of information that
helps the reader to solve a particular problem.

7 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing has many names – practical, informational,

workplace, professional, business or transactional writing.
Technical writing is the presentation of information that
helps the reader to solve a particular problem.
Technical writing is the practice of documenting
processes, such as software manuals or instructional
materials.

7 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing has many names – practical, informational,

workplace, professional, business or transactional writing.
Technical writing is the presentation of information that
helps the reader to solve a particular problem.
Technical writing is the practice of documenting
processes, such as software manuals or instructional
materials.
Traditionally, it was limited to user manuals of some sort.

7 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing has many names – practical, informational,

workplace, professional, business or transactional writing.
Technical writing is the presentation of information that
helps the reader to solve a particular problem.
Technical writing is the practice of documenting
processes, such as software manuals or instructional
materials.
Traditionally, it was limited to user manuals of some sort.
Today technical writing encompasses all documentation of
complex technical processes.
It includes reports, executive summary statements, briefs.

7 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

Nutrition benefits on the cereal box

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

Nutrition benefits on the cereal box

Business letters and catalogs that come in the mail

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

Nutrition benefits on the cereal box

Business letters and catalogs that come in the mail
Written instructions for assembling a new product

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

Nutrition benefits on the cereal box

Business letters and catalogs that come in the mail
Written instructions for assembling a new product
Tax receipts and notices

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Any time technical information is conveyed in writing at

work, it is, by definition, technical writing such as:
Directions on the toothpaste tube

Nutrition benefits on the cereal box

Business letters and catalogs that come in the mail
Written instructions for assembling a new product
Tax receipts and notices
Product safety information

8 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports
Write technical proposals

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports
Write technical proposals
Various forms of technical communication

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports
Write technical proposals
Various forms of technical communication
Technical writing is sometimes defined as simplifying the
complex.

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports
Write technical proposals
Various forms of technical communication
Technical writing is sometimes defined as simplifying the
complex.
Technical writing is a significant subset of the broader field
of technical communication, that involves communicating
complex information to those who need it to accomplish
some task or goal.

9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical writing is the writing of those involved in the
technical fields, i.e., science and engineering. In science and
engineering
Write technical reports
Write technical proposals
Various forms of technical communication
Technical writing is sometimes defined as simplifying the
complex.
Technical writing is a significant subset of the broader field
of technical communication, that involves communicating
complex information to those who need it to accomplish
some task or goal.
The term “technical” refers to knowledge that is not
widespread, that is more the territory of experts and
specialists.
9 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical report writing is a type of writing that

communicates technical information in a clear and concise
manner

10 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical report writing is a type of writing that

communicates technical information in a clear and concise
manner
Technical reports are written documents that describe the
process, results, and conclusions of technical projects or
experiments

10 / 24
Technical Report Writing-ME-303

What is Technical Writing

Technical report writing is a type of writing that

communicates technical information in a clear and concise
manner
Technical reports are written documents that describe the
process, results, and conclusions of technical projects or
experiments
These reports are typically used to communicate the findings
of technical research to a specific audience, such as engineers,
scientists, or policymakers.

10 / 24
Technical Report Writing-ME-303

What is Technical Writing

11 / 24
Technical Report Writing-ME-303

Goal of Technical Writing

Good technical writing results in

relevant, useful and accurate information sent to
specifically targeted audiences in order
to enable a set of actions on the part of
the audience in pursuit of a defined goal.

12 / 24
Technical Report Writing-ME-303

Goal of Technical Writing

Good technical writing results in

relevant, useful and accurate information sent to
specifically targeted audiences in order
to enable a set of actions on the part of
the audience in pursuit of a defined goal.
The goal may be using
a software application,
operating industrial equipment,
preventing accidents,
safely consuming a packaged food,
assessing a medical condition,
complying with a law, or
coaching a sports team.

12 / 24
Technical Report Writing-ME-303

Goal of Technical Writing

If the activity requires expertise or skill to perform, then

technical writing is a necessary component to guide.

13 / 24
Technical Report Writing-ME-303

Goal of Technical Writing

If the activity requires expertise or skill to perform, then

technical writing is a necessary component to guide.
Only a small proportion of technical writing is actually aimed
at the general audience otherwise aimed at specific.

13 / 24
Technical Report Writing-ME-303

Goal of Technical Writing

If the activity requires expertise or skill to perform, then

technical writing is a necessary component to guide.
Only a small proportion of technical writing is actually aimed
at the general audience otherwise aimed at specific.
For example: Businesses and organizations deliver vast
amounts of technical writing to explain
internal procedures,
design and produce products,
implement processes,
sell products and services to other businesses, or
define policies.

13 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Unclear and inaccurate information can seriously affect your

effectiveness.

14 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Unclear and inaccurate information can seriously affect your

effectiveness.
Readers need to clearly understand the language and
accurately retain the key points.

14 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Unclear and inaccurate information can seriously affect your

effectiveness.
Readers need to clearly understand the language and
accurately retain the key points.
Most businesses depend on logical, concise, and accurate
information.

14 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Unclear and inaccurate information can seriously affect your

effectiveness.
Readers need to clearly understand the language and
accurately retain the key points.
Most businesses depend on logical, concise, and accurate
information.
Without a common framework for producing timely, error-free
documents, mistakes often occur, delays strain partnerships,
and revenue is threatened.

14 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Unclear and inaccurate information can seriously affect your

effectiveness.
Readers need to clearly understand the language and
accurately retain the key points.
Most businesses depend on logical, concise, and accurate
information.
Without a common framework for producing timely, error-free
documents, mistakes often occur, delays strain partnerships,
and revenue is threatened.
It has never been more important to adopt internal writing
standards that match your customers’ standards as well.

14 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Employers want to hire people who can communicate

effectively, both in writing and orally.

15 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Employers want to hire people who can communicate

effectively, both in writing and orally.
In fact, we are told that on the job, an employee will spend at
least 20 percent of his or her time writing.

15 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Employers want to hire people who can communicate

effectively, both in writing and orally.
In fact, we are told that on the job, an employee will spend at
least 20 percent of his or her time writing.
This number increases as an employee’s responsibilities
increase.

15 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Employers want to hire people who can communicate

effectively, both in writing and orally.
In fact, we are told that on the job, an employee will spend at
least 20 percent of his or her time writing.
This number increases as an employee’s responsibilities
increase.
Managers spend up to 50 percent of their time writing.

15 / 24
Technical Report Writing-ME-303

Importance of Technical Writing

Employers want to hire people who can communicate

effectively, both in writing and orally.
In fact, we are told that on the job, an employee will spend at
least 20 percent of his or her time writing.
This number increases as an employee’s responsibilities
increase.
Managers spend up to 50 percent of their time writing.
CEOs spend between 80 and 100 percent of their work week
communicating.

15 / 24
Technical Report Writing-ME-303

Test

16 / 24
Technical Report Writing-ME-303

Test

What percentage of time does a manager spend writing? Or a

new employee, or a CEO?

16 / 24
Technical Report Writing-ME-303

Test

What percentage of time does a manager spend writing? Or a

new employee, or a CEO?
Define technical writing

16 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The sole purpose of technical writing is to educate and inform.

17 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The sole purpose of technical writing is to educate and inform.

Technical writing does not involve expressing opinions or
emotions about a topic.

17 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The sole purpose of technical writing is to educate and inform.

Technical writing does not involve expressing opinions or
emotions about a topic.
Technical writing documents are geared towards a highly
specific audience.

17 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The sole purpose of technical writing is to educate and inform.

Technical writing does not involve expressing opinions or
emotions about a topic.
Technical writing documents are geared towards a highly
specific audience.
Technical writing requires in-depth research and extensive
knowledge.

17 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The sole purpose of technical writing is to educate and inform.

Technical writing does not involve expressing opinions or
emotions about a topic.
Technical writing documents are geared towards a highly
specific audience.
Technical writing requires in-depth research and extensive
knowledge.
In technical writing the information is organized, presented
and communicated in a specific format.

17 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The writing is concise, clear and accurate.

18 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The writing is concise, clear and accurate.

The writing takes into account the audience’s needs and prior
understanding.

18 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The writing is concise, clear and accurate.

The writing takes into account the audience’s needs and prior
understanding.
The writing presents information to help readers solve a
problem or gain a better understanding of a situation.

18 / 24
Technical Report Writing-ME-303

Characteristics of Technical Writing

The writing is concise, clear and accurate.

The writing takes into account the audience’s needs and prior
understanding.
The writing presents information to help readers solve a
problem or gain a better understanding of a situation.
The writing conveys complex, or specialized information in a
way that is easy for a non-technical reader to understand.

18 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

Technical Writing and Creative Writing are different styles of

writing, which address different subjects and audiences.

19 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

Technical Writing and Creative Writing are different styles of

writing, which address different subjects and audiences.
The purpose of Technical Writing is to educate or instruct
about technical material, the purpose of Creative Writing is
limitless.

19 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

Technical Writing and Creative Writing are different styles of

writing, which address different subjects and audiences.
The purpose of Technical Writing is to educate or instruct
about technical material, the purpose of Creative Writing is
limitless.
Technical Writing is always non-fiction, and Creative Writing
can be fiction, non-fiction, or a combination of the two, and
can be used to educate or instruct.

19 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

Technical Writing and Creative Writing are different styles of

writing, which address different subjects and audiences.
The purpose of Technical Writing is to educate or instruct
about technical material, the purpose of Creative Writing is
limitless.
Technical Writing is always non-fiction, and Creative Writing
can be fiction, non-fiction, or a combination of the two, and
can be used to educate or instruct.
Technical Writing generally addresses a technical audience,
Creative Writing can potentially do the same, as is often the
case in science fiction.

19 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

Technical Writing and Creative Writing are different styles of

writing, which address different subjects and audiences.
The purpose of Technical Writing is to educate or instruct
about technical material, the purpose of Creative Writing is
limitless.
Technical Writing is always non-fiction, and Creative Writing
can be fiction, non-fiction, or a combination of the two, and
can be used to educate or instruct.
Technical Writing generally addresses a technical audience,
Creative Writing can potentially do the same, as is often the
case in science fiction.

Technical Writing audiences can be some time non-technical.

19 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

The Technical Writing voice must be clear, concise, and

accurate, in order to express effectively, the subject matter
and material being presented.

20 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

The Technical Writing voice must be clear, concise, and

accurate, in order to express effectively, the subject matter
and material being presented.
Clarity and accuracy are not integral to a creative writing
voice, though they can make the writing better, depending on
authorial intent.

20 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

The Technical Writing voice must be clear, concise, and

accurate, in order to express effectively, the subject matter
and material being presented.
Clarity and accuracy are not integral to a creative writing
voice, though they can make the writing better, depending on
authorial intent.
Creative writing is written mainly to entertain with the
creativity of the mind and technical writing is written mainly
to inform in a formal manner or to incite the reader to make
an action such as purchase the writer’s product.

20 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

SUBJECTIVE information: personal opinion, judgment,

feelings, or point of view.
OBJECTIVE information: factual and based on
observations and measurements.
21 / 24
Technical Report Writing-ME-303

Technical versus Creative Writing

22 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Technical writing deals with science, engineering and

technology.

23 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Technical writing deals with science, engineering and

technology.
Typical documents include
specifications,
manuals,
data sheets,
research papers,
field reports and
release notes

23 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Technical writing deals with science, engineering and

technology.
Typical documents include
specifications,
manuals,
data sheets,
research papers,
field reports and
release notes
Business writing is just about any other kind of writing
people do at work, except journalism and creative writing.

23 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Technical writing deals with science, engineering and

technology.
Typical documents include
specifications,
manuals,
data sheets,
research papers,
field reports and
release notes
Business writing is just about any other kind of writing
people do at work, except journalism and creative writing.
It includes reports, emails, proposals, minutes, letters,
copywriting, bids and tenders.

23 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Crossover between Technical and Business Writing.

24 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Crossover between Technical and Business Writing.

Many bids and proposals contain technical data and
specifications.

24 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Crossover between Technical and Business Writing.

Many bids and proposals contain technical data and
specifications.
So business writers may find themselves editing technical
content, and technical writers may be called upon to write
persuasive documents for a non-technical audience.

24 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Crossover between Technical and Business Writing.

Many bids and proposals contain technical data and
specifications.
So business writers may find themselves editing technical
content, and technical writers may be called upon to write
persuasive documents for a non-technical audience.
Business writing can be about explaining things clearly, but it
can also involve some public relations.

24 / 24
Technical Report Writing-ME-303

Technical versus Business Writing

Crossover between Technical and Business Writing.

Many bids and proposals contain technical data and
specifications.
So business writers may find themselves editing technical
content, and technical writers may be called upon to write
persuasive documents for a non-technical audience.
Business writing can be about explaining things clearly, but it
can also involve some public relations.
If you’re writing to customers, you might need to try to make
the company or product sound good.

24 / 24