Tech Writing Final Module
Tech Writing Final Module
TECHNICAL ENGLISH 1
(TECHNICAL REPORT WRITING
AND PRESENTATION)
Computer Arts and Technological College, Inc.
Balintawak Street, Albay District, Legazpi City
INTRODUCTION
Technical Writing
Overview
History
Techniques
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.
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 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.
Learning Objectives:
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 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.
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.
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
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 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
Learning Objectives:
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.
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.
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.
TECHNICAL DOCUMENTATION
Technical communicators often work hand and hand to create written products or deliverables.
These deliverables are technical documents that contain technical information. Examples of these
is police reports, police correspondence and issuance, legal documents, corporate disclaimers,
policies and procedures, business proposals, and procedure manuals. A technical documentation
services comprise of all activities, means, and system that provide information to its specialized
fields.
Technical writing is a part of the communication process and with that comes along the
technical communicator, whose job involves any form of technical communication.
1. AMBIGUOUS – referring to anything that is unclear to the reader that in turn causes
confusion and misunderstanding. An ambiguous written material may confuse a reader
and disrupts comprehension.
2. CONCISE – anything that gives information in a few words but in a complete and clear
manner. A well-written material is presented with conciseness.
3. CORRESPONDENCE – this is the act of corresponding or the writing and receiving of
letters and communication between two parties. This is done with offices, stations, units
within the law enforcement agencies, and its related organizations.
4. COMPRISE – this is to show how anything is consist of or composed of. A good written
communication is compromise of good writer, and a receptive reader.
5. CONVENTIONS – these are accepted rules considered to e correct, following any given
form of standards. A correctly written report follows all the conventions of grammar,
mechanics, and style.
6. COLLABORATIVE – the act of working jointly with others to achieve something
which is already set as a goal to be achieved. A good technical writer knows how to
collaborate with other technical experts.
7. DISCLAIMERS – these are persons or written materials denying a connection with or
responsibility of anything.
8. DISSEMINATE – the act of spreading anything widely so people will be informed
about pieces of information.
9. EXEMPLIFIES – this is to illustrate something or anything through the giving and
using of examples.
10. TECHNICAL – anything that is relating to any particular or specific subject or field or
specialization.
REFERENCES
SELF-CHECK
Instruction: Write T if the statement is TRUE, F it is FALSE in the blank before each number.
CONTENT:
1. Basic Elements of Grammar
2. Intended learning outcome
3. Subject Complement
4. Four kinds of sentence according to its structure
METHODOLOGY:
ASSESSMENT TASK
7. Written Exam
8. Essay
9. Oral Exam
Learning Activities Special Instruction
1. To know how to use correct grammar 1. The overview of learning outcome 1.3 is about
when writing a communication letter. the basic grammar and subject complement.
2. To understand the proper format of 2. Study the different types of sentences
making different types of report. according to its structure.
Note: The learning activities in information 1.2 are to determine if you understand the topic in
lesson 1.3
SUBJECT
The subject of a sentence is the person, place, or thing that is performing the action of the
sentence. The subject represents what or whom the sentence is about. The simple subject usually
contains a noun or pronoun and can include modifying words, phrases, or clauses.
The Man….
The sentence and its kinds are also emphasized to aid the learner in composing parallel
paragraphs using appropriate transitional markets and sentences free from errors of comma
splices and dangling modifiers. Moreover, agreement and grammar rules are reviewed to remind
the learner that correct grammar and usage are important factors in good writing, because a
professionally written material will lose its significance when correct grammar usage is not
followed.
The word in the English language can be designated to one of the eight categories, known
as the part of speech. The meaning and the word and the way the words are used in a
sentence determine what part of speech it is. These parts of speech are considered as one of
the basic elements of grammar. Each of the part functions in accordance with the standard
rules of grammar.
Nouns are the label or names given to the people, places, and things about which human
beings communicate.
Pronouns on the other hand, are word used in replacement of nouns.
Verbs are words of group that express time while showing an action, a condition, or the
fact that something exist. Every complete sentence contains at least one verb.
PREDICATE
The predicate expresses action or being within the sentence. The simple predicate contains the
verb and can also contain modifying words, phrases, or clauses.
The man / builds a house.
The subject and predicate make up the two basic structural parts of any complete sentence. In
addition, there are other elements, contained within the subject or predicate, that add meaning or
detail. These elements include the direct object, indirect object, and subject complement. All
these elements can be expanded and further combined into simple, compound, complex, or
compound/complex sentences. (See TIP Sheet on "Sentence Type and Purpose.")
DIRECT OBJECT
The direct object receives the action of the sentence. The direct object is usually a noun or
pronoun.
The man builds a house.
The man builds it.
INDIRECT OBJECT
The indirect object indicates to whom or for whom the action of the sentence is being done. The
indirect object is usually a noun or pronoun.
The man builds his family a house.
The man builds them a house.
SUBJECT COMPLEMENT
A subject complement either renames or describes the subject, and therefore is usually a noun,
pronoun, or adjective. Subject complements occur when there is a linking verb within the
sentence (often a linking verb is a form of the verb to be).
The man is a good father. (father = noun which renames the subject)
The man seems kind. (kind = adjective which describes the subject)
Note: As an example of the difference between parts of speech and parts of a sentence, a noun
can function within a sentence as subject, direct object, indirect object, object of a preposition, or
subject complement.
FOUR KINDS OF SENTENCES ACCORDING TO STRUCTURE
Sentence structure refers to the physical nature of a sentence and how the elements of
that sentence are presented. Just like word choice, writers should strive to vary their sentence
structure to create rhythmic prose and keep their reader interested. Sentences that require a
variation often repeat subjects, lengths, or types.
Related information about varying sentence structures can be found through these links:
Understanding sentence type will help writers note areas that should be varied using clauses,
conjunctions, and subordinators.
TYPES OF SENTENCE ACCORDING TO FUNCTION WITH EXAMPLES
In addition to classifying sentences by the number of clauses they contain, you can pigeonhole
sentences according to their functions. There are four sentence functions in English: declarative,
exclamatory, interrogative, and imperative.
REFERENCES
https://www.infoplease.com/homework-help/writing-grammar/sentences-sentence-functions-
four-tops
https://academicguides.waldenu.edu/writingcenter/scholarlyvoice/
sentencestructure#:~:text=There%20are%20four%20types%20of,no%20conjunction%20or
%20dependent%20clause.
SELF-CHECK
Instruction: Explain your answer based on the lesson in learning outcome 1.3
1. Discuss the basic grammar elements and the purpose of using correct grammar in
writing.
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________
________________________________________________________________________