Scribd
Upload
66 views12 pages

Technical Writing and Its Characteristcs

Technical writing encompasses documentation of complex technical processes across many fields such as manufacturing, engineering, biotech, and IT. It includes reports, summaries, briefs, emails, and other documents that convey technical information in writing. Technical writing is characterized by use of scientific vocabulary, various writing styles, and clear, concise explanations. The key principles of technical writing are understanding the reader and purpose, having subject matter expertise, writing objectively, and using the correct format. The end products of technical writing include abstracts, brochures, letters, contracts, reports, manuals, and memos.

Uploaded by

Acatech Cab
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
66 views12 pages

Technical Writing and Its Characteristcs

Technical writing encompasses documentation of complex technical processes across many fields such as manufacturing, engineering, biotech, and IT. It includes reports, summaries, briefs, emails, and other documents that convey technical information in writing. Technical writing is characterized by use of scientific vocabulary, various writing styles, and clear, concise explanations. The key principles of technical writing are understanding the reader and purpose, having subject matter expertise, writing objectively, and using the correct format. The end products of technical writing include abstracts, brochures, letters, contracts, reports, manuals, and memos.

Uploaded by

Acatech Cab
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
You are on page 1/ 12

Characteristics, Principles and Outputs

TECHNICAL REPORT WRITING

TECHNICAL WRITING
Traditional Definition of Technical Writing

The traditional definition of technical writing is:

“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.”
New Definition of Technical Writing

Today technical writing encompasses all documentation of


complex technical processes. It includes reports, executive
summary statements, briefs. Any time technical information
is conveyed in writing at work, it is, by definition, technical
writing.
This can include high-tech manufacturing, engineering,
biotech, energy, aerospace, finance, IT, and global supply
chain.
The format is no longer bound to lengthy user manuals.
Technical information must be distilled and presented
unambiguously. This can come in the form of technical
reports, emails, policy, briefs, and press releases.

The bottom line is if you work in a technical field you are


most likely performing technical writing.
Characteristics of Technical
Writing
 Technical writing deals with a subject matter.
 Technical writing is characterized by formal elements such as
scientific and technical vocabulary.
 Technical writing utilizes writing styles e.g. description, cause and
effect, classification, illustration, partition, comparison and contrast.
 Technical writing presents and explains a subject matter in a clear,
accurate, and concise manner. It maintains an attitude of impartiality
and objectivity and by the absence of any attempt to arouse
emotions.
6 Basic Principles of Technical Writing
Understand the reader
 A writer should always have in mind a specific reader (real or imaginary). The writer
assumes that the reader is intelligent but uninformed.
Know the purpose of the technical report
 The writer determines the exact purpose of his report, and should make sure that
every word, sentence and paragraph contributes to that purpose.
Know the subject matter
 A writer must have sufficient knowledge of the subject he is to write about.
Basic Principles of Technical Writing

Write Objectively
 The writer should use a language that is simple, concrete and familiar.
A good technical writer must emphasize the facts and the data.
Use Correct Format
 The technical writer should make his report attractive to look at.
Adopt Ethical Standards
 A good technical writer acknowledges the help he receives from others
and documents sources of reference materials.
6 Zall’s Holistic Guide to Technical Writing

 Accuracy
 A writer must be tactful in recording data, statement or calculating

mathematical figures. An error committed and an illogical statement can


create confusion as well as doubts over the whole text.
 Brevity
 Being brief means courtesy to the reader. The reader should get the essence

of your thinking in a compressed form.


 Confidence
 The writer should be decisive or sure of what he is writing about.
Zall’s Holistic Guide to Technical Writing
 Dignity
 The writer must be certain that all grammatical constructions are correct. You

need to be formal with your words and know the words are used.
 Emphasis
 The writer should know what is important to the reader and never expect that

the reader will find it out for himself. He has to lead them from point to point.
 Facility
 This refers to the devices used by the writer to make his report easy to read and

understand. The link from one part to another should be clearly established,
illustrated or stated.
End Products of Technical
Writing

 Abstract- A condensed form of a long piece of written


work.

 Brochure- A set of printed information printed on specially


chosen materials in min-book form or loose sheets.

 Business Letters/Correspondence- Written communication


to link businessmen with customers or clients.
End Products of Technical
Writing
 Contract- A written document between persons, companies or
organizations which contains details of matters mutually agreed
upon.

 Feasibility Report- Presents facts, information that clarify the financial,


economic, technical and beneficial aspects of a plan.

 Graphic Aids- Come in pictures, graphs, diagrams, tables, sketch forms


and are used to illustrate important details in reports.
End Products of Technical
Writing
 Instructional Manual- A technical document which briefly describes
the product and its purposes.

 Laboratory Report- Specifically describes the scope of a project,


instrument and materials used, steps undertaken and results,
conclusions and recommendation drafted.

 Memorandum- Written communication circulated within the


company and its branches.

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy