REVIEWER IN TECHNICAL WRITING

*Understanding the Nature of Technical Writing*

Technical Writing - Is writing about scientific subjects and about various technical subjects associated with sciences.
- Is characterized by certain formal elements, such as its scientific and technical vocabulary, it use of
graphic aids, and its use of conventional report forms.
- Is ideally characterized by the maintenance of attitude of impartiality and objectivity, by extreme
care to convey information accurately and concisely, and by the absence of any attempt to arouse
emotion.
- Is writing in which there is relatively high concentration of certain complex and important writing
techniques, in particular description of mechanisms, description of process, definition,
classification, and interpretation.

PRODUCTS OF TECHNICAL WRITING

Business Letter - A type of written communication. It is written using formal language and follows formal elements of
letter writing. People usually write business letters to communicate with companies, organizations, or
individuals with the purpose of applying for a job, making requests, seeking appointments, etc.
Contract - Is a written agreement between two people under mutually agreed terms.
Monograph - Is a detailed essay or book on a very specific topic. It is usually written by professionals or academicians
on topics of interest concerning their specific fields.
Printed Action Memo - Is a ready-format memorandum that only requires a checkmark on the appropriate box that
contains the message. This is especially useful for busy people who need to make quick decisions and act on the
circumstance or situation.
Graphic Aids - Are drawings, sketches, and illustrations that aid the readers in understanding the presented data.
Instructional Manuals - Are written to guide the readers on how to assemble, maintain, and operate an apparatus,
machine, or gadget.
Brochures - Are pamphlets or flyers that endorse a product in such a way that the potential customer will be convinced
that the product is effective and eventually avail of the product.
Proposals - Are written suggestions on how to make the company or organization more productive and successful. Most
companies and organizations require this before an agreement is reached.
Memoranda - Are inter-office written communication used to disseminate information.

5 IMPORTANT PRINCIPLES IN GOOD TECHNICAL WRITING

1. Always have in mind a specific reader, real or imaginary, when you are writing a report.
2. Before you start to write, always decide what the exact purpose of your report is, and make sure that every
paragraph, every sentence, every word makes a clear contribution to that purpose.
3. Use language that is simple, concrete, and familiar.
4. At the beginning and end of every section of your report, check your writing according to this principle:
“First, you tell the reader what you’re going to tell him/her, the you tell him/her what you’ve told him/her.
5. Make your report attractive.

PURPOSES OF TECHNICAL WRITING

1. It serves as basis for management decision.
2. It furnishes needed information.
3. It gives instructions.
4. It records business transactions through proposals.
5. It procures business proposals.
6. It serves as basis for public relations.
7. It provides report to stockholders of companies.
PROPERTIES OF TECHNICAL WRITING
1. Subject Matter - is an essential element in technical report writing. Some examples of this are description of a
process, writing about a theory, or submitting a policy
2. Audience - This is a property which pertains to a particular reader of a technical literature or report.
3. Expression - This refers to two basic modes in which a technical report has to be delivered, writing it or reading it.
4. Style - This refers to how the material is written.
5. Arrangement of Materials - This pertains to how ideas should be organized chronological, spatial, or logical
order, from specific to generals, and use illustrations to present information.

HOW TO IMPROVE YOUR TECHICAL WRITING SKILLS

1. Read - One of the best ways to become a better writer is to read. Reading helps you train your brain to
understand how to write. The more you read, the easier writing will become for you.
2. Create a Process - Having a clear workflow will help you systematically accomplish your work.
3. Seek Feedback - Getting subjective and objective feedback on your writing is one of the fastest ways to improve
your skills.
4. Take a course - Taking a class can be one of the most efficient ways to quickly boost your writing skills.
5. Practice - Repetition is the key to cementing your new skills.

5 BASIC TYPES OF WRITING

1. Technical Writing - Conveys specific information about a technical subject to a specific audience for a specific
purpose.
2. Creative Writing - Is fiction—poetry, short stories, plays, and novels—and far different from technical writing.
3. Persuasive Writing - Depends on emotional appeal. Its goal is to change one’s attitudes or motivate him/her to
action.
4. Expressive Writing - Is a subjective response to a personal experience—journals and diaries—whereas technical
writing might be objective observations of a work-related.
5. Expository Writing - “exposes” a topic analytically and objectively, such as news reports. Like technical
writing, the goal of expository writing is to explain or reveal knowledge, but expository writing does not
necessarily expect a response or action from the reader.
*Relevant Laws and Ethical Considerations Related to Technical Writing*

FOUR BODIES OF LAW RELATED TO TECHNICAL WRITING

1. Copyright Law - This law covers the protection of the rights of the author (written material, printed material,
software, or photographs)
2. Trademark Law - This law pertains to federal protection (protects a word, phrase, symbol or design that is
used by an entity to identify its product or service)
3. Contract Law - This law covers written warranties (specific facts about the features of a product or service) or
their implied warranties (an example of the contract theory noted above: a product is presumed to do what the
manual and the package show it to do.)
4. Liability Law - This law pertains to responsibilities or obligations of writers especially claims they made on their
paper.
- In a nutshell, product liability law says that a product is legally (even though not necessarily
technically) “defective” when it does not provide the safety that a user is reasonably entitled to
expect. Negligence does not need to be proved all a claimant has to show is the defective product,
the injury and the causal link between the two. This is known as “strict liability” . Instructions for
use are usually considered by the Courts as part of the product they accompany, so poor
instructions can make a technically sound product “defective” in a legal sense ; for example, by
describing how it may be used in unintended ways.

PRINCIPLES OF ETHICAL COMMUNICATION

“Technical writers are like researchers. Both take into consideration the bounds and limitations to things
that they write. They carefully study the information to be presented and they are aware that prudence has to be
exercised.”

DO’S OF TECHNICAL COMMUNICATION

1. Abide by relevant laws
2. Abide by the appropriate corporate or professional code of conduct
3. Tell the truth
4. Be clear
5. Avoid discriminatory language
6. Acknowledge assistance from others

DON’TS OF TECHNICAL COMMUNICATION

1. False implications- assuming the outcome of a project or making sweeping generalizations.
2. Exaggerations- expressing situations in extreme proportions.
3. Euphemisms- writing about situations in seemingly good conditions even though they are not.
4. Don’t mislead your readers.
*The Writing Process*

3 BASIC STAGES OF WRITING

1. Pre-Writing Stage - In this stage, the writer composes or supplies information pertaining to:
Purpose of the paper - This is necessary to determine the content of the paper to be included, the
organization and style of the paper.
Choice of topic - A writer has to explain or justify his/her chosen topic.
Gathering Information - A writer must be able to find sources of information to enrich his/her topic.

PRE-WRITING TECHNIQUES
1. Keep a writer’s journal by recording personal experiences, perceptions, and ideas.
2. Do free writing. Write about whatever comes to mind.
3. Brainstorm by listing ideas as quickly as they occur.
4. Cluster by drawing lines and circles to show connections between ideas.
5. Ask questions using the news reporter’s 5Ws – Who? What? Where? Why? When? and How?
6. Read with focus.
7. Listen with focus.
8. Observe by noticing details around you through the senses.
9. Imagine.

2. Writing Stage

3. Re-Writing Stage
We revise to ensure that
1. The content of the paper is relevant
2. There is organization and coherence in the arrangement of ideas
3. Grammar and mechanics are clearly observed.