Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Tech Writing Module 2

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 19

 

      Computer Arts and Technological College, Inc.       


Balintawak Street, Albay District, Legazpi City

COLLEGE OF CRIMINAL JUSTICE EDUCATION 

TECHNICAL ENGLISH 1
(TECHNICAL REPORT WRITING
AND PRESENTATION)
Computer Arts and Technological College, Inc. 
Balintawak Street, Albay District, Legazpi City

OUTCOME-BASED LEARNING MODULES (OBLM)  


TECHNICAL ENGLISH 1 (TECHNICAL REPORT WRITING AND
PRESENTATION) 

Name of Ivy M. Ocharan


Instructor: 
Course/Subject Technical English 1 (Technical Report Writing and Presentation)
Title:   
No. of hours per 3 hours
week:   
Units:        3 units
Course/Subject The course covers the study of the concept of application of the
Description: appropriate report writing brevity, clarity, completeness and accuracy of
facts and presentation according to the prescribe format and style of
investigative report writing structure and feasibility studies. It includes
the fundamentals and styles of different report writings and contents of
police report writing, manner of handling standards police forms and
technique sequences of blotter entries.

Unit Title: Technical English 1 (Technical Report Writing and Presentation) 


Course Learning CLO1: Conduct Criminological research on technical ways of writing
Outcome: reports on different type of offenses. CLO2: Apply the Principles of and
Jurisprudence of Criminal Law, and criminal evidence in writing
technical reports. CLO3: Collaborate effectively and independently in
multi-disciplinary and multi-cultural teams in writing police reports.
CLO4: Engage in lifelong learning and writing police reports in
promoting developments of criminology and criminal justice. CLO5:
Apply professional, social, and ethical standards in writing police reports.
CLO6: Effectively communicate orally and in writing police reports
using both English and Filipino.
TABLE OF CONTENTS 

INTRODUCTION 
Technical Writing 
Overview
History
Techniques

THE SIGNIFICANCE OF TECHNICAL WRITING 


Definition of Technical Writing 
Basic Principles of Good Writing 
The purposes and subject of Technical Writing 
Qualities of a Good Technical Report 
The Technical Communication 
The Technical Communicator 
Characteristics of a Good Technical Communicator 
Technical Documentation 
INTRODUCTION

    Careers in criminology and criminal justice certainly require a wide variety of skills. Among
the most important skills and abilities, those looking for jobs in criminology will need, no matter
their specific field, is the ability to communicate in various forms. Written language is perhaps
the single most valuable skill career seekers should possess.
(https://www.thebalancecareers.com/writing-skills-criminology-974623)
    Written communication is vital in every aspect of the criminology career. Police officers write
reports; criminologists issue proposals, policy papers and studies; and forensic science
technicians produce written records of their findings and conclusions. Writing is one of the most
fundamental abilities in every career option within criminology. Here are a few reasons why you
should want to hone your writing skills now so you can be more effective in the future:
Face it; first impressions do matter, whether you want them to or not. The simple fact is
that in most cases, your written reports will be the first and only introduction you will ever have
to some especially important and high-ranking people. Whether you are presenting a survey or a
study you have just completed, or you are writing an arrest report, your written word will be seen
and reviewed by judges, politicians, lawyers, and the press.
A poorly written report can leave someone with a bad impression of not only your
abilities and intelligence but your dedication, as well. Often, people will think badly of someone
who they perceive has not taken the time to complete a well-written or thorough report.
Conversely, a report that is professionally written can make a tremendous first impression
and lead to new contacts and new opportunities down the road. Whether you like it or not, it
matters what people think of your work product.
 
 
 

LEARNING OUTCOME 1.1

UNTRODUCTION IN TECHNICAL ENGLISH 1 


CONTENT:
1. Technical Writing 
2. Overview
3. History
4. Techniques

METHODOLOGY:

1. Practical Exercises 
2. Written Exam
3. Group Activity
4. Online Discussion
5. Lecture using Zoom.

ASSESSMENT TASK

1. Written Exam 
2. Essay
3. Oral Exam 

Learning Experience 1.1

Learning Outcome 1.1 INTRODUCTION IN TECHNICAL ENGLISH 1 

 
Learning Activities          Special Instruction 
1. To understand the purpose of technical 1. The information sheet 1.1 is the overview of the
writing in making a report.  introduction in technical English 1.
2. To gain knowledge how to create a 2. Study the different types of police report.
different types of police report. 
Note: The learning activities in information 1.1 are to determine if you understand the topic in
lesson 1.1.

Information Sheet 1.1 


INTRODUCTION IN TECHNICAL ENGLISH 1

Learning Objectives: 

After reading the information sheet you should be able to. 

1. Understand the importance of innovative policing.


2. Gain knowledge about the relation of Globalization and Technologies 
3. Understand, how drug trafficking groups utilize new technologies.
4. To know the difference of Globalization and Terrorism
5. Understand the impact of Al-Qaeda terrorist group and the effect of their terrorist activity in
the community. 

LEARNING OUTCOME 1.1 

INTRODUCTION IN TECHNICAL WRITING 1 

Technical writing is writing or drafting technical communication used in technical and


occupational fields, such as computer hardware and software, engineering, chemistry,
aeronautics, robotics, finance, medical, consumer, electronics, biotechnology, and forestry.
Technical writing encompasses the largest sub-field in technical communication. 
The Society for Technical Communication defines technical communication as any form
of communication that exhibits one or more of the following characteristics: "(1) communicating
about technical or specialized topics, such as computer applications, medical procedures, or
environmental regulations; (2) communicating by using technology, such as web pages, help
files, or social media sites; or (3) providing instructions about how to do something, regardless of
how technical the task is.”
A technical report (also scientific report) is a document that describes the process,
progress, or results of technical or scientific research or the state of a technical or scientific
research problem. It might also include recommendations and conclusions of the research.
Unlike other scientific literature, such as scientific journals and the proceedings of some
academic conferences, technical reports rarely undergo comprehensive independent peer
review before publication. They may be considered as grey literature. Where there is a review
process, it is often limited to within the originating organization. Similarly, there are no formal
publishing procedures for such reports, except were established locally.
Technical reports are today a major source of scientific and technical information. They
are prepared for internal or wider distribution by many organizations, most of which lack the
extensive editing and printing facilities of commercial publishers.
Technical reports are often prepared for sponsors of research projects. Another case
where a technical report may be produced is when more information is produced for an academic
paper than is acceptable or feasible to publish in a peer-reviewed publication; examples of this
include in-depth experimental details, additional results, or the architecture of a computer model.
Researchers may also publish work in early form as a technical report to establish novelty,
without having to wait for the often-long production schedules of academic journals. Technical
reports are considered "non-archival" publications, and so are free to be published elsewhere in
peer-reviewed venues with or without modification.
OVERVIEW 

    Technical writing is performed by a technical writer (or technical author) and is the process of
writing and sharing technical information in a professional setting. A technical writer's primary
task is to communicate technical information to another person or party in the clearest and most
effective manner possible. The information that technical writers communicate is often complex,
so strong writing and communication skills are essential. Technical writers not only convey
information through text, but they must be proficient with computers as well. Technical writers
use a wide range of programs to create and edit illustrations, diagramming programs to create
visual aids, and document processors to design, create, and format documents. 
While technical writing is commonly associated with online help and user manuals, the
term technical documentation can cover a wider range of genres and technologies. Press releases,
memos, reports business proposals.  Datasheets, products descriptions and specifications, white
papers, resume, and job applications are but few a few examples of writing that can be
considered technical documentation. Some types of technical documentation are not typically
handled by technical writers. For example, a press release is usually written by a public relations
writer, through a technical writer might have input on any technical information included in the
press release.
HISTORY 
    While technical writing has only been recognized as a profession since World War II, its roots
can be traced to classical antiquity. Critics cite the works of writers like Aristotle as the earliest
forms of technical writing. Geoffrey Chaucer's work, Treatise on the Astrolabe, is an early
example of a technical document. The earliest examples of technical writing date back to the Old
English period. 
With the invention of the mechanical printing press, the onset of the Renaissance and the rise of
the Age of Reason, documenting findings became a necessity. Inventors and scientists like Isaac
Newton and Leonardo da Vinci prepared documents that chronicled their inventions and
findings. While never called technical documents during their period of publication, these
documents played a crucial role in developing modern forms of technical communication and
writing. 
The field of technical communication grew during the Industrial Revolution. There was an
increasing need to provide people with instructions for using the more and more complex
machines that were being invented. However, unlike the past, where skills were handed down
through oral traditions, no one besides the inventors knew how to use these new devices. Writing
thus became the fastest and most effective way to disseminate information, and writers who
could document these devices were desired. 
During the 20th century, the need for technical writing skyrocketed, and the profession finally
became officially recognized. The events of World War I and World War II led to advances in
medicine, military hardware, computer technology, and aerospace technologies. This rapid
growth, coupled with the urgency of war, created an immediate need for well-designed and
written documents that chronicled the use of these technologies. Technical writing was in high
demand during this time, and "technical writer" became an official job title during World War
II. 
Following World War II, technological advances led to an increase in consumer goods and
standards of living. During the post-war boom, public services like libraries and universities, as
well as transport systems like buses and highways, saw massive amounts of growth. The need for
writers to chronicle these processes increased. It was also during this period that large business
and universities started using computers. Notably, in 1949, Joseph D. Chap line authored the first
computational technical document, an instruction manual for the BINAC computer. 
The invention of the transistor in 1947 allowed computers to be produced cheaper than ever
before. These reduced prices meant that computers could now be purchased by individuals and
small businesses. And because of the computer's growing prominence, the need for writers who
could explain and document these devices grew. The profession of technical writing saw further
expansion during the 1970s and 1980s as consumer electronics found their way into the homes of
more and more people. 
In recent years, the prominence of computers in society has led to many advances in the field of
digital communications, leading to changes in the tools technical writers use. Hypertext, word
processors, graphics editing programs, and page layout software have made the creation of
technical documents faster and easier, and technical writers of today must be proficient in these
programs.
TECHNIQUES 
    Good technical writing is concise, focused, easy to understand, free of errors, and audience
based. Technical writers focus on making their documents as clear as possible, avoiding overly
technical phrases and stylistic choices like passive voice and nominalizations. Because technical
documents are used in real-world situations, it should always be explicitly clear what the subject
matter of a technical document is and how to use the presented information. It would be
disastrous if, for example, a technical writer's instructions on how to use a high-powered X-ray
machine were difficult to decipher.
Technical writing requires a writer to extensively examine their audience. A technical
writer needs to be aware of their audience's existing knowledge about the material they are
discussing as the knowledge base of the writer's audience determines the content and focus of a
document. For example, an evaluation report discussing a scientific study's findings that is
written to a group of highly skilled scientists will be very differently constructed than one
intended for the general public. Technical writers do not have to be subject-matter
experts (SMEs) themselves. They often collaborate with SMEs to complete tasks that require
more knowledge about a subject than they possess. 
Technical writing must be accurate. A technical writer, after analyzing their audience,
knows what they need to communicate and then needs to convey the message in an accurate and
ethical manner. Physical, environmental, or financial repercussions could result if a writer does
this incorrectly. Knowing the audience is essential to accuracy because the language will be
tailored according to what they already understand about the subject at hand. For example,
instructions on how to assemble a bookshelf correctly and safely are included with purchase.
Those instructions are constructed so that anyone can follow along, including accurate details as
to where each fastener goes. If those instructions were inaccurate, the bookshelf could be
unstable and fail. 
Document design and layout are also vital components of technical writing. Technical
writers spend large amounts of time ensuring their documents are readable because a poorly
designed document hampers a reader's comprehension. Technical document design stresses
proper usage of document design choices like bullet points, font-size, and bold text. Images,
diagrams, and videos are also commonly employed by technical writers because these media can
often convey complex information, like a company's annual earnings or a product's design
features, far more efficiently than text.
Technical writing is a type of writing where the author is writing about a particular
subject that requires direction, instruction, or explanation. This style of writing has a very
different purpose and different characteristics than other writing styles such as creative writing,
academic writing or business writing.

Technical writing is straightforward, easy to understand explanations and/or instructions


dealing with a particular subject. It is an efficient and clear way of explaining something and
how it works.

The subject of technical writing can either be:

 Tangible - Something that can be seen or touched, such as a computer or software


program, or information on how to assemble a piece of furniture.
 Abstract - Something that involved a series of steps that are not related to a tangible
object. One example of this might be steps required to complete an office process.

Some examples of technical writing include:

 Instruction manuals
 Policy manuals
 Process manuals
 User manuals
 Reports of analysis.
 Instructions for assembling a product.
 A summarization of a long report that highlights and shortens the most important
elements.

TIPS FOR GOOD TECHNICAL REPORT WRITING 

Regardless of the type of document, which is written, technical writing requires the writer to
follow the properties of knowing their audience, writing in a clear, non-personal style, and doing
extensive research on the topic. By including these properties, the writer can create clear
instructions and explanations for the reader.
 Know your audience. An expert in the field will understand certain abbreviations,
acronyms, and lingo that directly applies to such a field. The novice will not understand
in the same manner and, therefore, every detail must be explained and spelled out for
them.
 Use an impersonal style. Write from a third person perspective, like a teacher instructing
a student. Any opinions should be omitted.
 The writing should be straightforward, to the point, and as simple as possible to make
sure the reader understands the process or instruction. This at times may appear as simply
a list of steps to take to achieve the desired goal or may be a short or lengthy explanation
of a concept or abstract idea.
 Know how to research. Gather information from several sources, understand the
information gathered so that it can be analyzed thoroughly, and then put the information
into an easy-to-understand format to instruct those who read it. The more inexperienced
your audience, the more information you will need to gather and explain.
 Be thorough in description and provide enough detail to make your points; but you also
must consider that you need to use an economy of words so that you do not bore your
reader with gratuitous details.

A good technical writer can make a difficult task easy and can quickly explain a complex piece
of information. 

REFERENCES
https://en.wikipedia.org/wiki/Technical_writing
https://grammar.yourdictionary.com/word-definitions/definition-of-technical-writing.html
https://en.wikipedia.org/wiki/Technical_report#Description
SELF-CHECK 
Instruction: Kindly give your best answer in the following question. 
1. What is technical report writing?
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
2. What is the importance of technical English 1 or technical report writing in
conducting investigation?
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
3. Kindly explain the main role of technical English 1 or technical report writing in
Law enforcement organization?
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________

LEARNING OUTCOME 1.2 

THE SIGNIFICANCE OF TECHNICAL WRITING 

CONTENT:
1. Definition of Technical Writing 
2. Basic Principles of Good Writing 
3.The purposes and subject of Technical Writing 
4.Qualities of a Good Technical Report 
5. The Technical Communication 
6. The Technical Communicator 
7. Characteristics of a Good Technical Communicator 
8. Technical Documentation 

METHODOLOGY:

6. Practical Exercises 
7. Written Exam
8. Group Activity
9. Online Discussion
10. Lecture using Zoom.

ASSESSMENT TASK

4. Written Exam 
5. Essay
6. Oral Exam 
Learning Experience 1.2 

Learning Outcome 1.2 THE SIGNIFICANCE OF TECHNICAL WRITING 

 
Learning Activities          Special Instruction 
1. To gain idea about the 1. The content of information sheet 1.2 is to help the
characteristics of technical student, to understand the significance of technical
English.   writing. 
2. To know about the purposes and 2. Study the basic principles of good technical writing. 
subject of technical writing.
Note: The learning activities in information 1.2 are to determine if you understand the topic in
lesson 1.2

Information Sheet 1.2  

THE SIGNIFICANCE OF TECHNICAL WRITING

Learning Objectives: 

After reading the information sheet you should be able to. 

1. To understand the significance of Technical writing and its definition.


2. To gain knowledge about the qualities and characteristics of a good technical commander. 
3. To understand what technical documentation is. 
LEARNING OUTCOME 1.2 

THE SIGNIFICANCE OF TECHNICAL WRITING 

The Significance of Technical Writing 

    Technical Writing is a skill that must be acquired not only by every criminology student, but
also by those who are already practicing their profession in the criminal justice system. Every
practitioner, either in different law enforcement agencies or learners in the academe are
confronted with a variety of writing activities. Specifically, law enforcers are required to write
beat patrol reports, fill up routing slips, write traffic incident reports, compose blotter entries, and
submit various kinds of police reports. Likewise, those in the academe are also expected to hand
in research, proposals, feasibility studies, technical reports and many other classrooms written
output. 
     
    With this writing demands, the need for developing technical writing skill is highly expected.
The more that a person is inclined to learn and develop his writing skill, the higher is the positive
result of a good technical output.

DEFINITION OF TECHNICAL WRITING 

    The word “Technical” comes from the Greek word “techne” that means “skill” Technical
writing then is a form of technical skills and is used in fields like the military, police, computer
industry, robotics, finance, consumer electronics, biotechnology, and many other fields. 

BASIC PRINCIPLES OF GOOD TECHNICAL WRITING 


   
    Good technical writing is not an instant process, it does not happen overnight, because it
requires effort and training on the part of the writer to produce a good output. This is the main
reason why Mills and Walter (1988) pointed out important principles to be considered in
technical writing. These principles are enumerated as follows: 

1. The writer of a report must have a specific reader or group of readers in mind. 
2. He must decide what the specific purpose of his report is and make sure that every
part of his report contributes to that purpose. 
3. He must use specific, single, concrete word and familiar language that will not be
misinterpreted. 
4. He must make his report very presentable in format. The lay out must conform with
the standards forms of writing. 
TECHNICAL 
                                  Has a specific reader.
WRITER                                Has a specific purpose. 
                                  Uses familiar language. 
                                Produces reports that are presentable.                               

THE TWO IMPORTANT FACTORS OF TECHNICAL WRITING


 
    Writing is a form of communication; it becomes more effective if the technical writer must
consider two important factors-the purpose and the subject matter. 

    Subject matter refers to the objective information that the writer wants to convey; whereas
purpose refers to the goals that the writer wants to achieve for himself and his written output.
The illustration below exemplifies more on these concepts. 

PURPOSE 1. These are the concepts and information that point to the
completion of a specific task and decision on the part of
writer and the reader. 
2. This is the analysis on the events and its implication in
relation to the written text. 
3. It convinces, persuades, and influences the readers. 

1. This is the objective of a written material.


2. This tells readers what to do, and how to do a particular
SUBJECT reading task.
3. This gives information about recorded data in
criminology. Military, business, education, and the
like. 
                   
QUALITIES OF A GOOD TECHNICAL REPORT 

    Technical writer is required to have good writing skills, but also his technical reports must
have good qualities that are appropriate and relevant. Brevity, clarity, completeness, and
accuracy are the essential qualities to achieve this. 

1. BREVITY – this is the quality of writing which is characterized by the shortness or


briefness of the writing material; this is achieved through presentation of ideas in a short
but complete manner. 
2. CLARITY – this is condition of writing where ideas are simplified by making it easier
for the readers to understand. This is achieved by providing further examples,
illustrations, or diagrams to clarify he text. A conscientious writer considers that not all
readers are well-versed with specific terminologies, therefore it is his responsibility to
convey his idea as clearly as possible. 
3. COMPLETENESS – this is the quality of writing where the ideas in the paragraph are
entirely and free from inconsistencies and errors in any form. A good writer is aware that
one of his objectives is to present information that is entirely complete. 
4. ACCURACY – this refers to the exactness and correctness of writing, as this is a result
from precision, conformity to grammar, and adherence to writing standards. There are
writers who knows how to present their ideas, but they are inaccurate in presenting facts.
An effective writer is not only good at presenting his ideas but also accurate in conveying
all the complete facts. A well-written report is a product of an accurate writer. 

THE TECHNICAL COMMUNICATION 

    The most important aspect of communication is to disseminate information, and this is where
the written or the oral form of communication come in. Technical communication is the process
of conveying technical information through writing, speech, and other medium to an intended
audience. The main function of technical communication is to convey specific messages to
specific readers. 

TECHNICAL COMMUNICATOR 
    A technical communicator is a person whose job involves technical communication. Technical
communicators are those who design reading materials, edit proposals, write manuals, create
web pages, write laboratory reports, write newsletters, and submit various kinds of professional
documents. In addition, they are responsible for writing texts that are accurate, readable,
acceptable, and helpful to its intended audience. 

CHARACTERISTICS OF A GOOD TECHNICAL COMMUNICATOR 


    A good technical communicator is a person who has developed his good writing skills, has
mastered all the conventions of the written languages, and has good characteristics. These good
characteristics are the following. 

1. KNOW HIS AUDIENCE WELL-


A technical writer who knows his/her audience well and is in the position to suggest and
implement solutions to problems that nobody else identifies.
2. SERVES AS A “GO-BETWEEN” 
Whenever one group of people has specialized knowledge that other group does not
share, the technical writer bridges the gap.
3. A GEBERATOR OF TRUTH 
A technical writer choose that will be written, with the full knowledge that later readers
will depend on the accuracy of what has been written.
4. A GOOD TEACHER
He excels at explaining difficult concepts for readers who will have no time to read
twice. 
5. HAS AN EXCELLENT EYE FOR DETAILS 
He knows punctuations, syntax, and style, and can explain the rules governing them. 
6. KNOW HOW TO COORDINATE 
Though he works on his own much of the time, he also knows how to coordinate with the
collaborative works and graphics, artist, programmers’ printers, and various subject
matters experts. 
7. HE MUST ENOUGH EXPERTISE 
He is an expert in understanding the audience background and needs. 
8. KNOWS HOW TO GATHER INFORMATION 
He has a nose for information from existing documents and from subject matter experts.
9. HE IS RESPECTED AND CREDIBLE 
He is a person with credibility, and he is also a valuable and reliable source of
information. 
10. HAS A STRONG LANGUANGE SKILLS
He understands the highly evolved conventions of modern technical communications. 

You might also like