Technical Report Writing
Technical Report Writing
Technical Report Writing
TECHNICAL REPORT
WRITING
ENGLISH 220
SECOND SEM MODULE
NAME
1
TECHNICAL REPORT WRITING
DEFINITION:
- Technical writing is a type of writing used by scientist, engineers and other pro-scientific
and technical expositions about scientific and technical subjects associated with
sciences.
- Technical writing deals with an object, a process, or an abstract idea in the sciences or in
engineering, it stresses accuracy rather than style. Its tone is objective rather than
subjective or emotional.
- Technical content is the focus of writing rather than the author’s voice.
The main objective is to convey specific piece of information for a specific purpose to a
specific reader or group of readers. It is writing that involves a special knowledge. The
specific information is technical, that is, it is formal aspect of the fields above, written from
the specific point of view.
Technical writing uses a relatively high concentration on certain complex and important
writing techniques particularly description of a mechanism, description of process,
classification, cause and effect, comparison and contrast, analogy and interpretation.
2
TECHNICAL REPORT WRITING
2. CONSISTENT.
- The technical report must be consistent in form and style. Inconsistencies in technical
writing will confuse readers and convince them that your work is sloppy and
unprofessional. Inconsistencies are manifested in random and unnecessary capitalizations,
mixed sets of units of measure, indiscriminate use of abbreviations, punctuations, and
rules of grammar.
- The technical writer must keep everything in one consistent style to produce a technical
document that is well-written, educated, and conventional.
3. CLEAR.
- Technical writers are successful if their work can be readily understood by their readers or
their audience. Try to be specific rather than general. Use concrete familiar expressions
rather than the abstract.
- Unfortunately, some writers write as if all their readers had the same level of technical
expertise as they. They write in complicated, difficult-to-understand technical papers or
reports that have jargon, and run-on sentences.
b. Avoid jargon.
3
TECHNICAL REPORT WRITING
Some technical terminology is valid and necessary, but too much technical jargon
makes writing incomprehensible. Not every readers knows the latest “buzz-words” in
a specialized field. Your readers are busy people, and more likely, they will put your
report aside than to reach for a technical dictionary.
5. CONCISE
- Most people in industry and academia are extremely busy. Concise technical
writing is easier and less time –consuming to read than wordy technical writing. By avoiding
unnecessary repetition, wordy phrases, general words, jargon, you can produce readable
prose without sacrificing content. Your words and phrases should be precise, well-
organized, and to the point.
- Conciseness requires that unnecessary materials and too much expansion of details
from the report must be removed. Care must be exercised in the choice of words. Use
precise verbs and keep a balance between active and passive verbs. Avoid abstract nouns
and jargons. Eliminate needles structure words and stretched-out connectors.
6. COMPLETE.
- Sentences in the report should give complete information so that the reader can
unmistakably understand or comprehend its meaning. The reader need to ask question to
understand it. You must spell out abbreviations and acronyms which are used in the report
for the first time. Also, avoid ambiguous references. Nouns must precede pronouns which
refer to them. Watch out for the antecedents of pronouns like he, she, it, his, her, its, this,
that, these, those. The number of the pronouns must agree with the number of their noun
antecedents.
7. OBJECTIVE
4
TECHNICAL REPORT WRITING
- The report must speak factually, quantified or categorized. Regardless of his feelings,
prejudices, or biases, the writer must report the findings of the study.
8. FORMAL
- Technical writing convention requires that the report use standard formal English. When
you are in doubt as to the label and usage of a term, you must not fail to consult the
dictionary. Formality requires that you should avoid contractions and avoid the use of slang
words.
- Technical reports are written in the third person. The writer refers to himself as the
researcher, the investigator, the writer rather than “I” or “we”, for it is not “who” which is
important. It is ‘what” was done, and “how” it was done that matters. The process can be
done by any qualified individual in the field.
Report writing skill is valuable to you as your career progresses, and as you occupy positions of
authority you will have greater writing responsibilities. Your ability to present yourself and your
ideas in writing is one of those qualities which will enable you to gain recognition for your other
abilities.
The technical content is the focus of writing rather than the author’s voice.
The primary goal of any technical communication is to accurately and adequately transmit technical
information with clarity and ease, with precision and conciseness, in a logically organized report for
a particular purpose to a particular reader or a group of readers.
Mills and Walter say that “technical writing is characterized by formal elements such as its
use of scientific and technical vocabulary, its use of graphic aids, and its use of conventional
report forms.
5
TECHNICAL REPORT WRITING
1. TO INFORM
- It is written to make another person understand or do something. It is designed to fulfill a
need to tell and need to know.
6
TECHNICAL REPORT WRITING
7
TECHNICAL REPORT WRITING
WRITING OBJECTIVELY
A good technical writer must emphasize the facts and the data. The impersonal style is
basic to an effective technical writer. He represents facts, figures and statistics skillfully
woven around the subject matter or central theme and written in an impersonal
manner.
8
TECHNICAL REPORT WRITING
have to present facts and figures as gathered and required, using only those that are
pertinent to the report. A good technical writer acknowledges the help he receives
from others and cites sources of reference materials.
SCIENTIFIC ATTITUDE
- Judicious weighing of evidence is very important in a technical report. The best evidence is
one which is the most ample, the most pertinent and the simplest in explaining the facts
with the least additional evidence and the most in harmony with the rest of the available
evidence. The conclusions or recommendation should include all evidences in which the
judgment is made.
- The technical writer must know when he would say enough, and not overwrite. As a write
of his materials, he should know what to present, what to amplify, what to rewrite and
what to emphasize.
9
TECHNICAL REPORT WRITING
GENERALIZATION
- When the technical writer makes generalizations, he is giving probable conclusions derived
from the observation of factors. Since the report is based on generalizations, it is necessary
to describe the circumstances surrounding the report. Provide enough evidence, data and
samples to enable the reader to evaluate the generalizations for himself.
PRINCIPLES to be observed in organizing the material as cited by Alvarez (1981) are as follows:
1. To organize the material of a subject, first break it down into the component aspects.
2. To organize a report or paper, choose a suitable approach and make an outline that
implements it.
3. The basic unit of organizations is the paragraph.
4. Use these paragraph to present the related data, graphs to show trends and visuals to
clarify description.
5. Plan a report or paper thoroughly before starting to write.
6. Gather the necessary data through basic library research and primary services.
7. Write a first draft.
8. Revise and rewrite as often as necessary.
9. Write a final draft.
10. Place footnotes to acknowledge references and include a bibliography at the end of a report
or paper.
o The technical writer must understand the nature of his work. He should be able to help his
principals attain the target objectives. He must not only possess the technical writing ability
and technical expertise, he must also have the capability to grasp, analyze and interpret
unexpected events and situations that occurred during the writing of the technical report.
o The technical writer should have the ability to state facts clearly and accurately to organize
a variety of elements into a unified structure, and to describe logical generalizations.
10
TECHNICAL REPORT WRITING
The hallmarks of an effective technical writer is represented by this acronym REPORTER (Mosura
and Tenorio, 1999)
R - Resourceful
E - Energetic
P - Patient
O - Observant
R - Responsible
T - Trustworthy
E - Evaluative
R – Responsive
1. ACCURACY
- A report writer must be tactful in the recording of data, statement or calculating
mathematical figures. He must check every statement in its final form. An error committed
and an illogical statement written can create confusions as well as doubts over the whole
text. A writer should always aim to be understood.
2. BREVITY
- Being brief is a courtesy to the reader. The reader should find it easy to group the main
idea of the report. In the same manner, accuracy of the statements can easily be
maintained. The reader can get of your thinking in a compressed form.
3. CONFIDENCE
- A good report writer must have the quality of self-confidence. He cannot only
communicate but he has to be also decisive or sure of what he is writing about. After
finishing the last page of his report, he is an authority.
4. DIGNITY
- Dignity is courtesy to your readers as professionals. This is an ethical standards. The writer
must be certain that all grammatical constructions are correct. In report writing, you need
to be formal with words and how these words are used. You should be sure that the ideas
or information are well organized, simplified, summarized and expressed in
straightforward manner.
5. FACILITY
11
TECHNICAL REPORT WRITING
- This refers to the devices used by the writer, to make his report easy to read and
understand. In most cases, report writing depends more on pacing, sequence,
arrangement and continuity of ideas as well as information. A GRAMMATICAL CORRECTION
IS IMPORTANT. He should make his writing straightforward, logical and clear. The thought
from one part to another should be clearly established, illustrated or stated.
6. EMPHASIS
- The writer has to feel what is important to the reader and should never expect how the
reader finds it for himself. He has to lead him from point to point, clearly making every
step, directs the reader to the right way and gives him the reason for stopping at a
particular portion.
7. HONESTY
- Honesty is expected in a report. When a writer has borrowed some statements, ideas or
quotations, he has to acknowledge them either in footnotes, endnotes or cite the source
or author of the borrowed ideas or statements within the running text.
8. ILLUSTRATION
- Illustration materials such as charts, graphs, diagrams and photos are always helpful. The
writer should use them to clarify and support the text. They can be used to show situations
or trend or movement.
9. JUDGMENT
- The writer should qualify the data and information gathered by judicious weighing.
10.KNOWLEDGE
- The communication of knowledge is the primary objective of the report, but knowledge I
not only a collection of data or information. It involves interpretation and formulation of
conclusions. Without sound interpretation; the data will become useless.
11.LOGIC
- Logic is a chiefly process of classification. It is putting things in their proper places. It shows
the relations among groups of things and classes of groups. By thinking logically, one can
avoid the following trouble areas:
12
TECHNICAL REPORT WRITING
12.MECHANICAL NEATNESS
- This is the general appearance of the report. It must be neatly encoded or typed, properly
margined, free from typographical errors, erasures, crossing-outs and smudges.
13.NORMAL PROCEDURE
- The report is easier to understand if it conforms to the standard practices. The writer must
follow the acceptable arrangement of the different parts of the reports. If the writer
deviates from the normal procedure, he should inform his readers by explaining his
reasons for doing it.
14.OBJECTIVITY
- In technical writing, the writer should consider himself a s another person, uninterested
observer or an innocent bystander. In this instance, the third person point of view is
preferred. The writer should treat his subject matter the way he sees or observe it.
Technical reports avoid the use of the first person (I, me, my).
15. PLANNING
- This is primary in all activities. This gives the purpose and direction to what the technical
writer has to write. This involves thinking ahead of what one has to do, when to do it and who
is to do it. This will be reflected in a well-organized report.
16.QUALIFICATION
- The technical writer should select only these statements that have direct relationship with
the topic being discussed. The writer should evaluate the ideas or statements he will
include in the writing of the report.
17.REVISION
13
TECHNICAL REPORT WRITING
- This consists of more than merely correcting the spelling, punctuation, spacing and margin
errors. The writer must also check every statement for sense and relevance and be sure
that he has sad all that must be said. An effective report is all that is required to perfection.
The secret of good writing of the report.
18.STRAIGHT SENTENCES
- Sentences carry the full weight of the meaning of the report. The sentence to be employed
must be limited to only one idea or to closely related ideas. To avoid monotony, vary your
sentence structure and employ appropriate transitional devices. By employing such
devices, there will be a smooth transition from sentence to sentence. They will show the
readers the writer’s thoughts leading him to what the writer wants to communicate.
19.THOROUGHNESS
- The writer should treat well his subject matter. The writer should check the thoroughness
of his report from initial thinking to final submission. The writer is obliged to go over, the
subject, analyze and investigate it, organize and interpret the result and draw conclusions
whether it is positive or negative.
20.UNITY
- A report is unified when everything is clearly relevant to the main point under discussion.
Nothing should be left hanging. No question should be left unanswered. After all, the main
objective of a unified report is to let the readers feel that they have read everything
essential to the subject undertaken.
21.VIEWPOINT
- A report is written from a certain viewpoint: that of a reporter, proponent, researcher or
an author. The viewpoint is established in the first sentence and should be maintained
consistently throughout the report. Voice unity should be observed.
22.WORD CHOICE
The writer should choose the words that are fit to the reader’s understanding. Avoid
words which are difficult to understand.
23. ZEST
- Write only things that are worth writing and which are invigorating. Write as though you
were performing a service that only you can perform.
Writing should not be regarded as something difficult but something that is enjoyable
and pleasurable.
Below are the important “end” products of technical writing:
14
TECHNICAL REPORT WRITING
1. TECHNICAL REPORT
- This provides useful information about a complete program of work, for reference and
permanent record.
- Technical report is one of the most frequently used type of technical communication.
There are three subtypes of technical reports which will be discussed:
15
TECHNICAL REPORT WRITING
2. CONTRACT
- This is a formal agreement between two or more persons; organization or parties to do
something on mutually terms.
3. FEASIBILITY REPORT
- This represents facts and information intended to make the reader realize that the
proposed project or plan is financially, economically, significant as well as beneficial.
4. BUSINESS LETTER
- This is a written communication or message used to transact business which cannot be
conveniently conducted orally.
5. BROCHURE
- This is a pamphlet or printed information material given to a customer in order to convince
or persuade him to take action on the company’s services, ideas or products offered.
6. ABSTRACT
- This is a summarized form of resume of a long piece of writing.
7. INSTRUCTIONAL MATERIAL
- This contains directions for work procedure or policies, or for the use of technical
equipment or appliances. Instruction relies on clear, specific, complete directions
presented in sequential order. Directions of complicated step-by-step procedures should
be accompanied by graphic illustration.
8. PROPOSAL
- This contains suggestions for actions, usually involving change or performance. It may be to
solve a problem, suggest new project site, revise a policy or initiate a researcher report
project or terminate a project.
9. PROGRESS REPORT
16
TECHNICAL REPORT WRITING
- This contains an account of what has been accomplished on a project over, a specific
period of time and what may be expected in the next period.
10. POLICY
- A plan of action adopted or preserved by an individual, government, party, business and
industry or it may be a document containing a contract of insurance.
12. MONOGRAPH
- This is a thorough textbook treatment which requires full illustration and documentation.
13. MEMORANDUM
- This is an important form of written communication circulated within the company and its
branches which is used to disseminate a message or information.
- The content and style are determined by the relationship of sender and recipient.
- Memos may be written to ask or answer questions, to describe procedures and policies, to
remind people about appointments or meetings.
15. SPECIFICATION
- This contains detailed information about performance courses, materials for construction,
theory of operations, sample calculations, table and operating data and information.
17
TECHNICAL REPORT WRITING
- This prepared from requires only a check mark in an appropriate aquare to indicate its
message.
18
TECHNICAL REPORT WRITING
- Is addressed to employees and technicians who are most concerned with how to increase
their productivity and their incomes. Since they need to see how their jobs fit into the
overall company operation, the writer should explain as well as give directions.
4. OUTWARD (to consumers, public interest groups, stockholders, government and others)
- GO outside the company and the techniques of upward communication are used.
- These are group of busy people, so that what they need is a communication that is simple,
with the terms defined and a thorough discussion of facts and ideas. Potential costumers
want to know the cost, use and durability of the products.
- The public wants information on how one’s ideas will affect the environment or the
economy, and the stockholders want to know whether the organization is conforming to
government regulations or how it affects the natural economy.
Words are labels or symbols for things and ideas. There are times when the writer and the
reader are not in perfect agreement as to the referent for certain words. A reader may have
a different referent from the one the writer had in mind, or he may not have any referent at
all, so communication may not be achieved. It is, therefore, important to define key terms
in a study.
Definitions are a description o explanation of a word or thing by its attributes, properties or
relations that distinguishes it from all other things.
THERE ARE THREE KINDS OF DEFINITIONS IN REPORT: Informal, operational, and formal
definitions
19
TECHNICAL REPORT WRITING
When we write, our reader may not always understand the meaning of specialized words and
expressions we wish to use.
20
TECHNICAL REPORT WRITING
AMPLIFIED DEFINITIONS
1. WORD DERIVATION
- The origin of the word sheds light on its present meaning.
3. EXPLICATION
- The purpose of explication is to give the reader new information about the term
through clarification. Explication can be expanded by the use of word derivation,
comparison and contrast, analogy and example.
5. ANALYSIS
- Refers to the division of an item into parts. This method aids the reader’s
comprehension by allowing them to grasp the definition bit by bit.
7. BASIC PRINCIPLE
- State the principle and explain how it is applicable to processes and mechanisms.
21
TECHNICAL REPORT WRITING
8. LOCATION
- You can expand your sentence definition by mentioning where a thing is located or
found. Description should proceed from the known to the unknown, from the
exterior to the interior.
9. ANALOGY
- Analogy points out a similarity between otherwise dissimilar things. If something is
unknown to readers, they will be aided if you call attention to its similarity, however
slight, to something they do know.
10. ILLUSTRATION
- Drawings and diagrams can be very helpful for reinforcing definitions.
2. FORMAL DEFINITIONS and OPERATIONAL DEFINITIONS are placed in the text of the report,
in a special section of the Introduction title Definition of Terms, or in the glossary.
If placing definitions in the text would result in too many interruptions in the text, it is good idea to
make a separate list to be put the Glossary. If there are number of terms of highly critical
importance to an understanding of your report, they may be defined in a special section of the
Introduction under Definition of Terms.
WHAT TO DEFINE
1. Define familiar terms to the reader but are used in the report in a different sense.
Example: hostess, slave
2. Define unfamiliar terms but actually name things which are actually familiar to the readers.
Example: Analgesic (pain killer), Anorexia (lack of appetite to eat)
22
TECHNICAL REPORT WRITING
3. Define terms which are unfamiliar to the reader and which name scientific and technical
things and process with which he is also unfamiliar.
Example: mean (average), significant factor (important contributing or casual factor)
DEFINING ABSTRACT CONCEPTS ( such as beauty, truth, justice, loyalty, love) is more
difficult than defining concrete objects. Often such concepts cannot be adequately defined
in one-sentence objects. Definitions can be expanded by giving an example, by stating the
main characteristics of the object or concept.
Description of a Mechanism
Mechanism is any system of parts that operates in a definable way. It is an assembly of movable
part fixed with respect to frame of reference and designed to produce an effect. It is designed to
transmit power greatly in excess of that required to overcome the frictional and dynamic
requirements of the mechanism itself or to produce a desired relative movement of its parts.
Mechanism may be simple or complex, small or large.
o a simple mechanism has three main parts;
o a complex one has more than four main parts
Mechanism may be designed primarily (1) to transmit power greatly in excess of that required to
overcome the frictional and dynamic requirements of the mechanism itself, or (2) to produce a
desired relative movement of its parts.
23
TECHNICAL REPORT WRITING
The part-b-part description and the conclusion- begin with the description of the first
major part.
a. Divide it into subparts
b. Describe in detail means giving careful attention to the following aspects of the
mechanism such as the shape, size, and relationship to the other parts, methods
of attachment, material, finish. This aspects need not to be followed at all
because attention is given to them according to the reader and the subject.
c. The mechanism as a whole progressively broken down into smaller and smaller
units until common sense says it is time to stop. Then each of these small units is
described in detail.
STYLE – painstaking attention to detail can ensure accuracy of a description. You can put what
you have said in the form of a sketch or drawing being guided by the words you have written.
Usually the entire description is in the present tense.
24
TECHNICAL REPORT WRITING
Description of a Process
Is a series of steps aimed to achieve some results to get something done. It can mechanical
where the operator is seen or natural where the human operator is not seen.
The description of the process requires (1) be adapted to the needs of the reader, (2) the
organizational of the description be simple and chronological and include the discussion of
equipment and materials, (3) illustration of how the tool is held or how one step leads to
the next can add clarity to the text.
The explanation of a process is addressed to readers who may not perform the process but
wish to understand it so that they can judge its reliability, practicality, or efficiency.
25
TECHNICAL REPORT WRITING
Organization- in chronological order. The individual steps should be divide into substeps.
The description is essentially a miniature of the description of the process as a whole.
Conclusion- not always necessary to write a formal conclusion. Whether one is desirable,
depends, of course, on whether it will help the reader.
o Fixing the chief steps in mind.
o Recalling special points about equipment or materials.
o Analyzing the advantages and disadvantages of the process.
o Noting how this process is related to other processes or other work that is done, or
reported on.
“The writer must analyze his own report and his intended reader to decide whether a
conclusion is necessary”
CLASSIFICATION
- Act of locating a specimen of the different kinds of objects which possesses a given
characteristics. It permits clear, systematic information.
- Operate like a filing system that sort out items, objects, or ideas according to a basis or
governing principle.
- Divides a unit into parts, steps, or aspects
- To classify any group formally and completely involves considering every representative of
the group and breaking down classes into sub classes and so on until the ultimate discussion
is done.
26
TECHNICAL REPORT WRITING
properties. State the basis for classification before naming the members of a class so the
reader will understand you. Stick to the basis chosen.
3. Stick to the basis at a time in listing members of a class. Failure to do so will result to
mixed classifications. Use proper species name and use proper terms.
4. Name all the species according to a given basis. Tell the reader what the limitations are
so that he will not expect more than what you will present. Make clear what is being
classified and for what purpose.
5. The species of classification must be mutually exclusive. There should be no overlapping.
This means that a part has a place in only one division. Overlapping is cause by shifting
the basis of classification or wrong choice of words.
6. Help your reader understand the distinction between species by defining them,
describing them, or illustrating them, or use all these three.
7. In a sub- classification, discuss characteristics peculiar to that one sub-classification only.
Shape is not a useful distinguishing characteristics.
PARTITIONING
- Partitioning is a method of analysis which divides a unit into part, steps, or aspects..
It breaks down a singular item into parts or an abstract topic into divisions.
- The parts do not necessarily have anything in common except that they belong to
the same unit.
2. Each part in the division is distinctly a separate part. The parts must be mutually
exclusive. This means that each part or division can exist without the other divisions.
27
TECHNICAL REPORT WRITING
- Discusses the reason why something is true or the result of some peculiar event or state of
mind.
- May include other methods of development, like analysis, but the overall structure of the
written work will be based on the relationship of causes and effects.
Analogy
- one term is discussed according to terms which apply to the other
- expression of relationship between two different things, but between two things which
have more than one likeness
- wide range in length , from simple illustration to a long sustained development; in content,
from subject close to one to be explained to the greatly different, application from only a
relationship or two, to a detailed point by point comparison. But whatever its size, its
nature, or its use, the analogy has its purpose, clearness and its value as a clarifying device
makes it worthy of study.
Employing Persuasion
- The reader must convince that the idea presented in the communication is well-reasoned
and that the recommendation given is the best action to take.
Giving Instructions
- To enable the reader to perform a particular operation. The technical writer who is giving
the instructions expects the reader to act. Each step is presented and explained to the
reader who should carry out to perform the operation.
Interpretation
- Art of establishing a meaningful pattern of relationships among a group of facts.
- The process of interpretation is to decide what the purpose of the interpretation is
o Six major elements in a clear interpretation:
Acquiring a thorough grasp of all available information
Stating the problem in concise form.
Defining unfamiliar terms.
Distinguishing between primary problem and subordinate problem.
28
TECHNICAL REPORT WRITING
Distinguishing between what is already known and what remains to be found out
or decided.
Giving background information.
o How was the evidence obtained
Interpretation can be no better than the data on which it is based.
Second major interpretation is the provision of any necessary explanation about
how the data were obtained or of a statement of their probable reliability.
The information should be enough about the data so that he can make his own
interpretation if he wishes.
o Organization of the Main Part of the Interpretation
The interpreter must explain the significance of his evidence and state conclusion.
Three major factors that may be considered in stating and organizing
major data:
o The problem in concise form
o The subordinate or standards of judgment
o Possible explanations or possible choices
The term judgment maybe new but the idea is familiar.
FOREWORD
- Foreword or introduction defines the subject, scope, and purpose of the report. It may
explain why the work was undertaken and upon whose authorization. Reference to other
reports on the subject is desirable.
CONCLUSION
- The conclusion of a report summarizes the results of the test made and records discoveries.
The foreword states the problem and the conclusion interprets the results. This
29
TECHNICAL REPORT WRITING
interpretation should be written that the less specialized reader will have no difficulty in
comprehending it.
RECOMMENDATIONS
- Should be given emphasis by simple, forceful expression by being set off on separate lines
or paragraphs as in the following:
“We therefore, recommend that: / We also recommend that:”
DISCUSSION
- Body of the report and it contains the data collected during the investigation. The data are
tabulated or charted and are explained and interpreted. whenever possible it is advisable to
put the numerical test results under a separate heading: “RESULTS OF TEST”
2. FORMAL REPORT LAYOUT – this report contains all the part: cover page, title page, letter of
transmittal, table of contents, list of figures, abstract, headings, quotations, and listing,
equations and formulas.
4. THE MEMORANDUM REPORT – least formal of all reports. Includes: To, From, subject,
dateline, complimentary close or signature, the headings are type at the top of the page.
5. LETTER REPORT – it vary according to its purpose, the type of reader and the subject being
discussed.
6. BULLETINS – used for both internal and external communications. Commonly used to inform
their readers about personnel changes and policies.
7. BOOKLETS – they serve to inform. They are not longer than 3 pages, in fact, they are
practically of book length. Resembling books.
9. ABSTRACT – is to give the reader enough information for him to decide whether or not to
read the whole report.
30
TECHNICAL REPORT WRITING
a. Descriptive abstract – this tells what things are taken up in the report itself but not
mentioning what the reports say about these things. This abstract is short and easy
to write but contains little information.
10. ORAL REPORTS - the ability to communicate technical information orally is just as important
as the ability to write well. Oral presentations are faster, easier, and more suited to
immediate feedback and clarification.
Giving a formal oral presentation
a. Analyze your audience, and limit your topic accordingly.
b. Determine your primary purpose.
c. Select effective supporting information
d. Choose an appropriate pattern of organization
e. Prepare an outline.
f. Select appropriate visual aids.
g. Prepare a suitable introduction
h. Prepare a closing summary
11. CONFERENCES
12. PROPOSAL – a written offer to solve a technical problem in a particular way under a specified
plan of management for a certain sum of money. In other words it is a report which aims to
convince customers that the company or person presenting it is better qualified to give the
product or service.
TYPES OF PROPOSAL
1. SOLICITED PROPOSAL – written in response to a direct invitation to bid;
sometimes called a “ big request”. A “purchase request” or a request for
proposal. They are published in business journals, official government
publications or in the newspaper classified ads.
31
TECHNICAL REPORT WRITING
13. THE RESEARCH REPORT – presents the findings of an investigation of a problem which
developed from an unresolved conflict or situation.
Introduction
1. background of the study
2. statement of the problem
3. significance of the study
4. scope and delimitation of the study
5. hypothesis
Research Methodology
1. research population
2. instruments used
3. data- gathering procedure
4. statistical statement
Findings of the study
Summary, Conclusions and Recommendation
14. FEASIBILITY STUDY- is a technical proposal although much more detailed than the ordinary
proposal. It offers recommendations.
Feasibility study may have the following parts:
1. objectives of the project
2. analysis of the progress of similar studies conducted elsewhere
3. comparisons of the project with previous ones
4. plans - initials, actual and future
5. schedule of activities
32
TECHNICAL REPORT WRITING
If your superior tells you to write a recommendation report about something, you must start by
analyzing the problem, decide on the proper course of action or what decision is best justified by
the evidence, and make a forthright recommendation.
When you expect opposition to recommendations, you should give a good deal of thought to
the tone of your report and to methods of emphasizing the points which clarify the logic of the
situation.
The probable opposition first, is to discuss the advantages and disadvantages of the
preferred recommendation Be careful to state all its advantages fairly. Second, present the
advantages and disadvantages of the course of action. Third, give a summary and recommendation.
This approach provides emphasis through relative position- the value of the preferred action being
shown after the weaknesses of the alternative have been explained.
When you volunteer a recommendation, you ought to observe two cautions: (1) be sure
that your recommendation is sound and that you have shown clearly that it is sound. (2) Be careful
not to give the impression that you are trying to force your ideas on something.
Reports and proposals depend on research. The research maybe simple or complicated.
Care in planning, proposing, and researching reports is needed to produce reliable data.
VARIETES OF REPORTS/DEFINITIONS
Many documents are called reports. A report is either a long document that contains
numerical data, or one-and two-page memos only.
Reports supply the information that people in organization need in planning and solving
problems.
33
TECHNICAL REPORT WRITING
Reports are information reports if they collect for the reader, analytical reports if they
interpret data without recommending action, and recommendation reports if they
recommend action or solution.
INFORMATION REPORTS
The following reports are usually information reports:
Sales Reports list sales figures weekly or monthly.
Quarterly Reports document a factory’s productivity and profits for the quarter.
ANALYTICAL REPORTS
ANNUAL REPORTS record an organization’s achievement during the past year and provide
financial data.
AUDIT REPORTS document the facts revealed in audit and give an interpretation of them.
MAKE-GOOD or PAY-BACK REPORTS calculate at which point a new capital investment will
pay off.
INFORMATION/ANALYTICAL/RECOMMENDATION REPORTS
ACCIDENT REPORTS list accidents, their nature and causes, and can recommend measures
to make conditions safer.
CREDIT REPORTS summarize an applicant’s earnings and other credit obligations and
evaluate his or her collateral and credit standing.
COMMITTEE REPORTS document a committee’s work for a period of time.
PROGRESS REPORTS record the extent of work done and the work remaining on a project.
TRIP REPORTS share what the author learned during the trip.
CLOSURE REPORTS are documented researches that are not economically or technically
feasible for new products under the current conditions.
RECOMMENDATION REPORTS
SCOUTING REPORTS point out the strengths and weaknesses of an applicant or an opposing
team and recommend whether to bid for the applicant or recommend strategies for
defeating the opponent.
FEASIBILITY REPORTS evaluate two or more options and recommend which the organization
should choose.
JUSTIFICATION REPORTS justify the need for a building, an advertisement, a reorganization,
or a change in procedure.
PROBLEM-SOLVING REPORTS identify the problems and recommend solutions.
34
TECHNICAL REPORT WRITING
- Good report problems come from real problems: reality departs from the ideal. When you
write a report as part of your job, the topic may be defined for you.
2. Problem. What is wrong? Why is there need to solve it? Is there a background to this
problem?
3. Feasibility. Are you sure that a solution can be found during the semester? How do you
know?
4. Audience. Who in the organization can carry out your recommendation? Who else might be
asked to evaluate your report? Who would be affected by your recommendations? Will
anyone in the organization be a gatekeeper to determine whether your report will reach
decision makers?
35
TECHNICAL REPORT WRITING
5. Topics to Investigate. Prepare the questions and sub questions you will answer in your
report, the topics or concepts you will define, the aspects of the problem you will deal with.
Indicate to what extent you will examine each of the aspects you plan to discuss. Give
reasons for choosing to discuss some problems and not others.
6. Methods /Procedure. How will you secure answers to your questions? Whom will you
interview or survey? What publications will you use?
8. Work Schedule. Calculate both the total time your research will take and the date expected
to finish it.
9. Call to action. Indicate that you are open to any improvement of the research plan
suggested.
BUSINESS LETTERS
GOOD BUSINESS LETTER has the following qualities
1. creates favorable impression
2. Appeals to the reader’s point of view
3. Correct in every detail
4. Courteous, friendly and sincere
5. promotes goodwill
6. coherent and well-prepared
7. employs highly the business jargons
STATIONARY
Good taste rather than economy should be considered. The stationary should be of the best
quality that the user could afford since the stationary on which a letter is written enhances the
prestige of the writer.
36
TECHNICAL REPORT WRITING
OPTIONAL PARTS
1. Attention Line 4. CC Notation
2. Subject Line 5. BCC Notation
3. Enclosure Notation 6. Mailing Notation
37
TECHNICAL REPORT WRITING
CAPTIONS
- Place the caption above the table. You must choose the format you will use on your
captions: inverted pyramid, block style, indented style.
- CAPTIONS IN INVERTED SYTLE
Generally use uppercase and lowercase letters, though all uppercase letters may
be used. Capitalize thw first word, the last word, and all the principal words, with
th exception of articles (a, an, the), coordinate conjunctions (and, but, or, nor, for,
yet, so) prepositions (to, at, before between)and the word to in an infinitive
(when the words fall in the middle of the title)
The caption has no end punctuations. It is centered between left and right
margins.
Captions are place above the Tables and below Figures. The caption of a Table is
separated from the body of the table by double single horizontal lines separated
by only a fraction of the normal space, extending the width of the table and
placed a single space below the last line of the caption.
NUMBERING
- Tables are numbered consecutively in the report. They are usually numbered with Arabic
numbers, not Roman numerals.
38
TECHNICAL REPORT WRITING
INTERNAL FORMAT
- A table begins with a table number and its caption placed above the table.
- A table is separated from textual material by three spaces above and below.
o MARGINS – There should be two inches margin on the left side, one inch at the
bottom and right sides.
o PAGINATION – The page number is placed in its normal position, even if the table is
broadside on the page.
- A resume informs the employer what you know and what you have done; but importantly,
it is a way to show what you can do. After all, you are going to get a job. Which job is the
question.
- Employers look for people who can do the job. To learn who to hire, they may use resumes,
application forms, written tests, performance tests, medical examinations, and interviews.
- Written evidence of your qualifications are resumes and application forms. When making
these two, you need two different kinds of information:
o Facts about yourself and facts about the job you want.
With this information in hand, you can present the facts about yourself in terms of the job.
You have more freedom with a resume – you can put your best points first and avoid
blanks. But, even on application forms you can describe your qualifications in terms of the
job’s duties.
KNOW THYSELF
39
TECHNICAL REPORT WRITING
Begin with gathering data about yourself. Some items appear on every resume or application form,
including the following:
Present address and phone number or e-mail – if you are seldom home during business
hours, try to obtain an answering machine. Leave a message that would reflect well on you.
This is not the time for jokes! As an alternative, you may give the phone number of a friend
or relative who will take messages for you.
Job applied for or career goal.
Experience (paid or volunteer) – date of employment, name and full address of the
employer, job title, starting and finishing salary, and reason for leaving (moving, returning
to school, and seeking a better position are among the readily accepted reasons).
Education - the school’s name, its location, the years you attended it, the diploma or
certificate you earned, and the course of studies you pursued.
Other qualifications – hobbies, organizations you belong to, honors you have received, and
leadership positions you have held.
Office machines, tools and equipment you have used and skills that you possess.
Skills and achievements – more than duties and responsibilities. What you have
accomplished? What are your remarkable strengths? These are most likely related to your
work experience but could be related to your education or outside interests.
Other information, such as your ID number, is often asked for an application form but is rarely
presented on resumes. Application forms might also ask for a record of past addresses and for
information that you would reveal reluctantly, such as a record of convictions. If asked for such
information, you must be honest. Honesty does not, however require that you reveal disabilities
that do not affect your overall qualifications for a job.
40
TECHNICAL REPORT WRITING
Once you have gathered the information you need, you can prepare a
resume. You can prepare more than one master resume if you are looking for
different kinds of jobs. Otherwise, your resume will not fir the job you seek.
o USE SPECIFICS – A vague description of your duties will make only a vague impression.
o IDENTIFY ACCOMPLISHMENTS – If you were the leader of a project, improved productivity,
reduced costs, increased membership, or achieved some other goal.
o USE ACTION VERBS – Combine the specifics and the accomplishments with action verbs, for
example, supervised staff of 10; increased sales by 35 percent in two years; reduced
maintenance costs; set new standard in assembling parts of refrigerators without a flaw.
Note: Reverse Chronology is the easiest method to use, but the least effective because it makes
when you did something more important that what you can do. It is a format if you have gaps in
your work experience, if the job you seek is very different from the job you currently hold, or if you
are just entering the job market. Use such resume when you have climbed up a clearly defined
career ladder and want to move up a step further.
Resumes that do not start from the most recent, may be called functional, analytical, skill
oriented, creative, or some other name.
Make a functional resume by determining the skills the employer wants. Again, study the
job description for this information. Then, review your experience and education to see when you
showed the ability sought for. Then write the resume itself, putting first the information that
relates most obviously to the job.
APPEARANCE COUNTS
o Type your resume, using a standard typeface, or computerize it. (Printed resumes are
becoming more common, but employers do not indicate a preference for them).
o Use two pages at the most.
o Leave all embarrassing or negative information off the resume – but be ready to deal with it
positively at the interview.
o Proofread the master copy carefully.
41
TECHNICAL REPORT WRITING
o Ask someone else and a third person to proofread the master copy carefully.
o Use the best quality photocopying machine and good white or off-white paper.
o Name
o Phone number(s) at which you can reached or receive messages.
o Address
o Job or career applied for.
o References – often just a statement that references are available is enough. If your
references are likely to be known by the person who reads the resume, however, their
names are worth listing.
o Experience
o education
o Special talents
o Personal information – height, weight, marital status, physical condition. Although this
information often appears, it is not important to recruiters. If some of this information is
directly job related – the height is important to an employer.
- Request two copies of the form. If only one is provided photocopy it before you
make a mark on it. You will need more than one copy to prepare rough drafts.
- Read the whole form before you start completing it.
- Prepare a master copy if the same form is used by several divisions within the same
company or organization. Do not put the specific job applied for, date, and signature
on the master copy. Fill in the information on the photocopies as you submit them.
- Type or computerize the form if possible.
42
TECHNICAL REPORT WRITING
- Leave no blanks, enter n/a (for not applicable) when the information requested does
not apply to you; this tells people checking the form that you did not simply skip the
question.
- Carry a resume and a copy of other frequently asked information (such as previous
addresses) with you when you visit potential employers in case you fill out an
application on the spot.
When all your choices are complete, you will have the information about yourself that you
need to evaluate your potential job satisfaction in anew field or in an old one. You should
have a good start on sorting out the skills you wish to emphasize in your resume.
JOB INTERVIEWS
An interview is like a conversation with several features: A specific purpose, a
structural pattern - time, place, length, participants, and subject matter planned in
advance and one group or participant controls the proceedings and contributes
mainly questions – the other contributes mainly answers.
The participants adopt roles and are not equal partners. If you take part in an
interview – whether as an interviewer or interviewee – don’t expect to feel at ease.
After all, the setting in unnatural. But by practicing and adopting various strategies
you can cope with an interview.
As to interviews in the workplace, bosses or personnel managers conduct
interviews; to monitor employees’ progress (appraisal interviews); and to deal with
problems (disciplinary interviews). The inequality between the participants consists
of the boss or interviewer in the role of judge, with the power to employ, upgrade,
or fire the interviewee – the person in the witness box.
o RESPONSIBILITIES
The interviewee has to do him- or herself justice.
The interviewer (just like the judge) has to do justice, full stop. In case the
interviewer fails to decide correctly, injustice rebounds, not just on the affected
individuals, but on the company as a whole.
As interviewer, your first job is to carefully phrase the job description and
include the skills, qualifications, and personal qualities you are looking for.
Consider the candidate’s ability to work in a team or individually, to lead or to
follow, to be creative or to reproduce accurately someone else’s pattern of work.
Clear ad would means
43
TECHNICAL REPORT WRITING
The effectiveness of the questions depends on the wordings. Sift from the
application forms the inappropriate candidates- underqualified, semi-literate, or
whatever and prepare courtesy letters for these. Some application forms will
indicate clearly a suitable candidate. Invite them for interview.
Good questions in the application form will give useful information .
Background information gives work information and relevant skills.
Factual experience as you need to know should be included in the form.
Foreground information are explanatory topics – the applicant’s
attitudes, outside interests, or irrelevant skills. A driver’s license may
indicate relocation or multi-site work.
Two interviews test the candidate’s possible reaction to pressure in the workplace
by adopting opposing roles, one sympathetic and the other confrontational.
44
TECHNICAL REPORT WRITING
- Set in a relaxed position, but do not slouch so as to put the interviewee on his guard.
Avoid uninviting gestures such as covering your mouth or frowning. Show all signs of
attentiveness – nodding your head, murmuring ‘mmm’ or ‘I see’ – and this will
encourage free and expansive talk from your interviewee.
- A pause in conversation is a problem in interviews.
- Let the interviewee do much of the talking.
- The interviewers may take note, but explain that you have to pause to jot down some
notes. Resume eye contact and continue the conversation.
- The effective interviewer has to deal with his prejudices. Some have predispositions –
low regard for women, etc.
DANGER AREAS TO BE MINDFUL OF:
o Too much emphasis on first impressions.
o Not considering into account the built-in tension and artificiality you will
assume that a nervous and reticent candidate will behave the same way once
employed.
THE INTERVIEW
o An interview has three parts: welcoming the interviewee, questioning the
interviewee, and concluding the interviewee.
In welcoming the interviewee, act friendly and in a business-like way. You
are the host and he is the guest. You may question the interviewee about
his trip or the weather to make the candidate feel at ease:
Tell him/her that everything said in the interview will be
confidential.
Give him an outline of the topics you will go over.
Reassure the applicant that he can also ask questions.
The questions in the interview should be based on the topics you listed as
rough guides. Questions must be flexible. Implications are gathered from
the interviewee’s responses and adjust your questions accordingly.
Open and close questions can be combined. As the interviewer
controls the flow of information, he is careful in switching from one to
the other type. Closed questions require brief answers such as yes or
no. Open questions are more demanding.
CONCLUDINGTHE INTERVIEW
o The interviewee is asked if s/he has questions to ask. The type of questions s/he
asks will affect evaluation of the interviewee.
THE INTERVIEWEE
45
TECHNICAL REPORT WRITING
THE INTERVIEW
- On the day of the interview, have plenty of time to get ready, and travel to the
venue. You also need to relax. A last- minute rush means you will arrive flustered.
- If you feel very nervous, try various relaxation exercises. Do voice and body warm-
up exercises.
- For support have an encouraging friend accompany you and to chat you.
- Think in advance what you will do when the interview is over. Whether feeling high
or low, you will need an activity to help you through the post-interview period.
- Before you speak you will be seen. The style of dress you choose depends on the
company and the position you are applying for, your appearance should indicate
that you know what is acceptable dress within the company.
- If you are in doubt about how to dress, phone the office secretary to ask.
- Make sure that your outfit is comfortable to wear, and that it suits you.
- Finally, take care not to walk into the interview room laden with all your
belongings.
46
TECHNICAL REPORT WRITING
BE FRIENDLY WITHOUR BEING FAMILIAR – Don’t slap the interviewer at the back.
BODY LANGUAGE – If the interviewer has not decided in advance where you should sit,
don’t sit on the low soft armchair. It invites a submissive, slouching posture which you
cannot easily control your body language. If the chair has arms, don’t put your elbows on
them. You are forcing yourself into a tense, unattractive posture. Sit upright, with your back
firmly supported by chair.
o As for body language, an ‘open’ posture with your back straight, and arms and legs
uncrossed, is better than a ‘closed’ posture – back hunched, arms and legs tightly
crossed.
o Make sure your body language does not give you away. Don’t turn away from the
interviewer, or wrap your arms around your chest in self-protection. Don’t look out
of the window, giving the interviewer the impression that you are inattentive rather
than that you are thinking seriously.
INTERVIEWERS TOLERATE NERVOUSNESS, but if you are feeling really jittery, focus on
controlling your breathing. If you do not know what to do with your hands, clasp them in
your lap. Avoid small repetitive movements: your nervousness will show and distract the
interviewer if you keep moving your foot, smoothing your hair, or nibbling your fingernails.
ESTABLISHING RAPPORT. Interviewing is based on taking turns: the better you are at
listening, the better are your responses. Listen carefully, and pause when answering to note
his or her responses. Recognize who is in charge. So, wait for the interviewer to finish
before you speak. And answer questions directly; don’t pretend you did not hear the
interviewer said, and don’t answer a question not asked.
o You might sense that you have no rapport. Don’t simply say you have encountered
with an awful interviewer. Perhaps it is you that is at fault. Consider the following
points.
Are you talking too much? Pause more often and give short answers.
Are your answers so short? Show the interviewer, by means of nods and
gestures, that you are interested in the questions and comments.
Respond with enthusiasm, speak clearly, and use facial expression
expressions as a visual aid to emphasize your meaning.
o TAKING QUESTIONS
Common questions
Why did you apply for this job?
What makes you want to work for this company/organization?
What do you think has been your outstanding achievement in your
career so far?
47
TECHNICAL REPORT WRITING
Prepared by:
48