0% found this document useful (0 votes)
3 views14 pages

Lecture 1

Technical report writing

Uploaded by

imad hassan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
0% found this document useful (0 votes)
3 views14 pages

Lecture 1

Technical report writing

Uploaded by

imad hassan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
Download as pdf or txt
You are on page 1/ 14

TECHNICAL REPORT WRITING

Lecture # 1

Imad Hassan
Lecturer
Energy Engineering Technology
University of Technology Nowshera
What is Technical Writing?

• You’re probably wondering what this “technical writing


thing” is. Someone may even have told you, “It’s this course
where they make you write about rocket science and brain
surgery.” Well, not really, as you will see in a moment.
Actually, the field of technical communication is essential in
a wide range of fields and occupations
• Technical writing is an audience-centered means of
communication that provides a reader with clear and easy
access to information. In the business world, time equates to
profit, and profit is the force behind all business interaction.
The technical writer and reader have a vis-à-vis relationship.
The writer recognizes, respects, and addresses the importance
of time in effective and efficient communication by providing
documents written in specific formats, using unambiguous
language to send clearly accessible information. The reader in
turn thoroughly understands the information in order to give a
thoughtful response.
The Meaning of “Technical”

• Technical communication—or technical writing, as the


course is often called—is not writing about a specific
technical topic such as computers, but about any technical
topic. The term “technical” refers to knowledge that is not
widespread, that is more the territory of experts and
specialists. Whatever your major is, you are developing an
expertise—you are becoming a specialist in a particular
technical area. And whenever you try to write or say
anything about your field, you are engaged in technical
communication.
Academic Writing Versus Technical Writing

• The definite purpose, strict format and use of appropriate


language in technical writing define the differences between
technical writing and academic writing. The academic
writer’s purpose may be to write an assignment, a story, a
letter, etc.. These works may or may not have a reader.
However, technical writing always has a definite purpose
and will always have a reader. Regardless of the number of
the intended readers of a document who may or may not
read the document, the document will be read by the
primary reader.
Workplace Writing

• However, the focus for technical-writing courses is not


necessarily a career as a technical writer but an introduction
to the kinds of writing skills you need in practically any
technically oriented professional job. No matter what sort of
professional work you do, you’re likely to do lots of writing—
and much of it technical in nature. The more you know
about some basic technical-writing skills, which are covered
in this guide and in technical-writing courses, the better job
of writing you’re likely to do. And that will be good for the
projects you work on, for the organizations you work in,
and—most of all—good for you and your
career.
Considerations of Technical Documents

• There are key components of what makes a document strong.


Therefore, writers keep these items in mind while constructing
technical documents.

The Importance of Audience

• Another key part of the definition of technical


communication is the receiver of the information—the
audience. Technical communication is the delivery of
technical information to readers (or listeners or viewers) in a
manner that is adapted to their needs, level of
understanding, and background. In fact, this audience
element is so important that it is one of the cornerstones of
this course: you are challenged to write about highly
technical subjects but in a way that a beginner—a non
specialist—could understand.
Formatting and Language

• Formatting and appropriate language are the basic design


elements of all technical documents. A format that shows a
hierarchical structure and a coordinate structure of
information leads the reader thorough text
• Readers should be able to identify a writer’s organizational
pattern very quickly when reading a technical document. This
sometimes refers to a document being “reader friendly.” In
addition, using appropriate language is significant in
providing the reader with a thorough understanding of the
purpose of the document
Cultural Communication

• Technical writers need to be aware of the differences


between the behavior and the norms, beliefs and values of
specific cultural
Ethics

• Technical writers must use words that demonstrate valid


appeals to reason, avoiding emotional words and phrases
that appeal to basic emotion instead of justifiable reasoning.
In addition, technical writers must use valid references to
support ideas and strategies, avoiding referencing non
experts to sway readers’ support. Also, technical writers
must use accurate numbers to report data, avoiding charts
and tables that skew data. Using any type of fallacies in
technical writing is unethical and could result in dire
consequences.

You might also like