Technical Writing Notes
Technical Writing Notes
Development - Uses examples, anecdotes, testimony, - Uses examples, anecdotes, Same for both
data, research testimony, data, research
Style - Uses short, denotative words; short - Uses longer, connotative Different
sentences; and short paragraphs words; longer sentences;
and longer paragraphs
6. Does that mean, therefore, that you must relearn all your teaching skills to accommodate this new
communication beast?
- Absolutely not. Many of the writing skills you already teach apply to technical writing. Others are less valid.
7. But what about our college-bound students? Why would they need technical writing?
- College typically lasts four to six years, and the K-12 education system should focus on preparing students for
both college and their future careers. This includes teaching essay writing as well as technical writing skills
that are essential for various jobs.
- Career and technical education students, such as mechanics and office assistants, will benefit from learning
to write technical documents. Similarly, students pursuing associate and bachelor degrees—who will become
professionals like computer programmers, engineers, and doctors—also need to develop skills in writing
memos, letters, and reports for their careers.
> How Can You Improve Your Technical Writing Skills? (Ballen, 2022)
1. Read as much as you can. Reading is a great way to improve your understanding of complex topics. When
you’re reading, pay attention to how the author presents information and try to imitate that style in your own
writing.
2. Write regularly. The more you write, the better you’ll become at technical writing. Set aside time each day to
practice your skills, and you’ll see a marked improvement over time.
3. Get feedback. One of the best ways to improve your writing is to get feedback from others. Find a friend or
colleague who can read your work and offer constructive criticism.
4. Use tools and resources. There are many great tools and resources available for technical writers. Check
out some of the links below to learn more about this field. So, that’s a quick introduction to technical writing.
As you can see, it’s an important field used in various industries. And remember, practice makes perfect, so
keep writing!
(3) Problem-Solving
- Love for solving puzzles and finding solutions to problems.
- A good technical writer needs to have strong problem-solving ability.
- They need to understand what problems might come up while they are writing, and how they can
solve them if they do. This will help them deliver the content on time, and avoid any mistakes that
could bring their project down.
- Technical Knowledge. Technical writers need to understand what they’re writing about. They must know the
background of their subject and how it works so that they can explain it clearly to readers
- Industry Knowledge. Technical writers must also be familiar with the industry their writing pertains to. They
need to know the terminology and what is generally accepted within that industry.
- Technical Writing Skills. Technical writing is a specific genre with its own set of rules. A good technical
writer must be familiar with the rules and how to apply them to technical writing situations
2. For Vocabulary. Cut jargon, reduce the number of multisyllabic words, and use vocabulary appropriate to the
audience.
3. For Sentences. Strive for average sentences, vary the sentence length, be careful to use compound subjects
and verbs, and use subject-verb-object word order.
4. For Content. concentrate on specific rather than abstract, get to the message quickly, and organize thoughts
into logical order.
5. For Style. Eliminate these, write in short paragraphs, put words that demand emphasis on the sentence, use
only simple or compound sentences, and do not overuse transitional words or phrases.
7. About Genderism. Writing requires us to refrain from using terms that discriminate or show biases in the
treatment of males and females. Neutral terms should be used to manifest fairness and equality among
people.
Bias Fair
if a woman drives – if a person drives
Businessman – businessperson
Man-made – artificial; synthetic; manufactured
Manpower – human power; workforce
Chairman – chairperson
Salesman – salesperson; sales clerk
Foreman – construction supervisor
10. About Voice of the Verb. Use active voice for clearer and more direct communication, especially in technical
and business writing.
(a) Active Voice: The subject performs the action (e.g., "The manager approved the budget.").
(b) Passive Voice: The subject receives the action (e.g., "The budget was approved by the manager.").
> Examples:
(1) To emphasize the receiver of the action more than the doer:
- Prefer (Passive) - The thirteenth month's pay is now being computed.
- Avoid (Active) -The treasurer is now computing the bonus for this year.
(2) To hide the names or identities:
- Prefer (Passive) - The program was assessed poorly.
- Avoid (Active) - The participants from private company assessed the program as
poor.
(b) If there is only one digit in the sentence, it will be written in words. But, in case a single digit is
accompanied by two or more digit numbers in the same sentence, that single-digit number shall be
written in the figure.
> Examples:
- We need to purchase four printers for the employees.
- We will buy 20 photocopying machines and 10 scanners.
(c) Spell out or write in words if the number represents time and is accompanied by the word o'clock. But
if not, write it in the figure.
> Examples:
- I will deliver these orders at eleven o'clock 2. She calls me at 6:30 PM
(e) Write in words the first number when two numbers are placed together in the same sentence.
> Examples:
- I need six 20-peso bills.
- She has two 1000-peso bills.
12. The Use of Goobledygook. It is the unnecessary use of long words and stuffy style in communications that
complicates the message of a letter or memorandum and makes it less understandable or readable to the
receiver. About this, a memorandum written by Arthur M. Schlessinger, Presidential Assistant to John F.
Kennedy mentioned that every presidential message should be:
(1) in English
(2) clear and trenchant in style
(3) logical in its structure, and
(4) devoid of gobbledygook. (Bernad, 2006)
Ethics
- Ethics are a set of values or beliefs we use to govern ourselves.
- Our ethics are based on moral ideals of what is believed to be "right" and "wrong" and inform and influence
the way we Interpret information, think, and act.
- Ethics are important in everything, including communication. A document can explain its purpose well,
address its audience correctly, and look very appealing. However, an unethical document puts the reader at a
disadvantage, not allowing him/her to make the best decision.
- In a multicultural society, we live in a world with multiple ethical standards. Ethics aren't always governed by
laws or clearly stated, but they greatly impact relationships and business practices.
- Effective business communication can be complex because you need to consider ethics from legal, business,
and cultural perspectives.
- What’s acceptable in one context may not be in another. It's crucial in business to recognize when actions or
behaviors may be unethical.
📌 Importance of Communication
> Importance of Communication
1. Communication is needed for the employees to express their problems to their fellow workers and to the
management, and in turn, management cannot also communicate and cannot give instructions to their
employees.
2. Communication helps accomplish all the basic management functions such as planning, organizing, directing,
and controlling so that organizations can achieve their goals and overcome problems.
3. When communication is effective, it tends to encourage better performance and job satisfaction.
An effective and efficient communication system requires managerial proficiency in delivering and receiving
messages. A manager must discover various barriers to communication, analyze the reasons for their occurrence,
and take preventive steps to avoid those barriers. Thus, the primary responsibility of a manager is to develop and
maintain an effective communication system in the organization.
2. Upward Communication: Information moves from lower levels (employees) up to higher levels (management
or leadership). This includes feedback, reports, and suggestions from employees to their superiors.
Ex. Grievance Redressal System, Complaint & Suggestion Box, Job Satisfaction surveys, performance
reports, employee attitude surveys, and letters from employees. employee-manager discussions etc.
3. Lateral Communication: Also called horizontal communication, this flow occurs between individuals or
departments at the same organizational level. It facilitates coordination, collaboration, and problem-solving
among peers. The advantages of horizontal communication are as follows:
- It is time-saving
- It facilitates the coordination of tasks
- It facilitates cooperation among the members of the team
- It provides emotional and social assistance to the members of the organization
- It helps in solving various organizational problems
- It is a means of information sharing
- It can also be used for resolving conflict in any department or in the whole organization.
Ex. employees collaborating to plan a joint campaign, sharing updates and ideas between their teams
4. Diagonal Communication: Information flows between different levels and departments, crossing both
hierarchical and functional lines. For example, a lower-level employee from one department communicates
directly with a senior manager in another.
Ex. A customer service representative communicates directly with a senior finance officer to clarify a billing
issue, bypassing the normal hierarchical structure of their departments.
5. External Communication: This involves communication between the organization and external parties, such
as customers, suppliers, or stakeholders, and includes marketing, public relations, and customer service
interactions.
Ex. The public relations team sends out a press release to media outlets about the launch of a new product,
or a customer service team handles queries from clients via email or phone calls.
(1) First Line - Name of Institution / Corporation represented by the writer (N/A if unemployed)
(2) Second Line - Business Address
(3) Most letters have logos
2. Date / Dateline
- Specifies when the letter was written
- Three single spaces after Heading
3. Inside Address
- Three single spaces after the Dateline
4. Salutation
- Greetings of the letter
- Usually with "Dear" (only if the letter is personal)
- Simply use Sir/Ma'am/Madam
- Follow the salutation with a colon (:) if it’s a formal letter
- Follow the salutation with a comma (,) if it’s a personal letter
- Three single spaces after the Inside Address
6. Complimentary Close
- Three or two single spaces after the body of the letter
- Only the first letter of the complimentary close is capitalized
- Comma (,) after the close
9. Enclosure
- Where attached documents are indicated
2. Letter of Reply
- Purpose: To respond to an inquiry or request.
- Common Uses: Provides the requested information or clarification, addressing the sender's concerns or
questions directly.
3. Order Letter
- Purpose: To place an order for products or services.
- Common Uses: Used by businesses or individuals to specify the items being ordered, including quantities,
prices, and delivery instructions.
4. Letter of Acknowledgement
- Purpose: To confirm receipt of a document, payment, or information.
- Common Uses: Often used in business to acknowledge applications, orders, payments, or complaints,
assuring the sender that their correspondence has been received.
5. Claim/Complaint Letter
- Purpose: To express dissatisfaction with a product or service and request resolution.
- Common Uses: Used by customers to formally address issues, such as defective products or poor service,
seeking compensation or corrective action.
6. Adjustment Letter
- Purpose: To respond to a claim or complaint, providing a resolution or explanation.
- Common Uses: Used by businesses to address customer grievances, offering solutions, apologies, or
compensations.
7. Letter of Directives/Instructions
- Purpose: To convey specific instructions or guidelines.
- Common Uses: Commonly used within organizations to inform employees of new policies, procedures, or
operational changes.
8. Reservation Letter
- Purpose: To request a reservation for services such as travel, dining, or accommodations.
- Common Uses: Used by individuals or organizations to secure bookings, specifying details such as dates,
number of guests, and preferences
9. Confirmation Letter
- Purpose: To confirm arrangements, such as meetings, appointments, or reservations.
- Common Uses: Used to ensure all parties have agreed on the specifics, including time, date, location, and
agenda.