Different Forms of Technical Writing
Different Forms of Technical Writing
Different Forms of
Technical Writing
LESSON 1
Basic Assumptions in Technical Writing
OBJECTIVES
At the end of the lesson, you are expected to:
differentiate writing for work over writing for school and in
education over practicality in workplace;
LESSON 1
Basic Assumptions in Technical Writing
1
Purpose: In school, writing assignments are primarily focused on
demonstrating knowledge and understanding of a subject. The goal is to
fulfill academic requirements and receive a grade. In contrast, writing for
work serves practical purposes such as conveying information, making
proposals, or solving problems within a professional context.
2
Audience: School assignments are typically written for instructors or professors
who have expertise in the subject matter. They expect a certain level of analysis
and may provide feedback for improvement. In a work setting, writing is often
directed towards colleagues, clients, or superiors who may have varying levels
of familiarity with the topic. The emphasis is on clear communication and
providing relevant information to the intended audience.
3
Structure: Academic writing often follows a specific structure, such as
introduction, body paragraphs, and conclusion. It emphasizes building
arguments and supporting them with evidence. In contrast, work-related writing
tends to be more concise and direct. The main point is usually presented at the
beginning, without extensive background information or lengthy explanations.
The structure may vary depending on the specific document or purpose, but the
focus is on delivering information efficiently.
4
Tone and Style: Academic writing often employs a formal and objective tone,
avoiding personal opinions or subjective language. Work-related writing can
vary in tone depending on the audience and purpose. It can range from
formal to more conversational, depending on the corporate culture and the
nature of the communication. It may also include specific jargon or technical
terms relevant to the field.
5
Revision and Feedback: In academia, the opportunity for revision is often
limited, and grades are assigned based on the initial submission. In contrast,
in the workplace, revisions are common, and feedback is an integral part of
the writing process. Colleagues or supervisors may provide input and
suggest changes to improve the clarity, effectiveness, or professionalism of
the document.
Education vs. Practicality
Not only are graphics visually appealing, but they also make a presentation easy to
navigate. Usually, they are discouraged in school papers. In the business field, visuals can be the
determining factor in getting a job, securing a deal, or impressing the boss. However, when
using graphics, make sure they are appropriate and related to the topic. It is very unprofessional
to send inappropriate graphics to your work force, and it may cause confusion if the graphics do
not relate to your topic. Graphics are used to enhance the document, not take away from it.
Teamwork
Many schools are starting to encourage writing in groups to
get a sense of the teamwork that you will experience in the
workplace. Collaboration at the office is common; even if you
aren’t part of a team, you might still consult co-workers and
readers. You may also submit drafts that are constantly being
revised.
Conventions and Culture
Another assumption you may have about technical writing is that it
almost never changes. But if you look at the word “technical” as it relates to
“technology,” you may find that technology is always changing. That is why
before you can become a successful technical writer, you must learn about
your organization’s style and about the social and political factors of your
writing.
Your Company’s Style: Technical writing is not a constant. Each company has its
own way of promoting itself, from a liberal and casual style to a conservative and formal
style. You will need to adjust your writing based on how the company wants you to
represent it.
Conventions and Culture
Ethics: play a significant role in technical writing. Workplaces often have ethics codes,
though their enforcement may vary. Ethics is not always straightforward and can be
subject to disagreement, which can complicate technical writing in certain situations.
Potential Complications
If you choose to be a technical writer, you will face many complications (potentially). For
the most part, they have to do with a changing world, changing beliefs, and changing
cultures.
Losing Focus of Your Goal: Remember, when it comes to technical writing, the more
concise and understandable your text is, the better. You may tend to wander off topic if
you’ve been working on a project for a long time, but this can severely damage your end
result. Keep focused and remember to leave any shred of an opinion out of your work.
GROUP ACTIVITY
1. In your own understanding, perspective, and/or experience (if you
already have), what else do you think would be different writing for school
and writing for work (especially in your field of specialization)?
9. Analytical and critical: Research involves analytical thinking and critical evaluation of data,
theories, and interpretations. It requires the ability to draw meaningful conclusions and implications
from the findings.
10. Transparent and accountable: Research should be transparent in its methods, procedures, and
reporting, allowing others to assess the reliability and validity of the study. Researchers should be
accountable for their work and be open to scrutiny and peer review.
Roles of a Researcher
Exploration: Research aims to explore new areas, topics, or phenomena, often with the
goal of generating new knowledge and understanding.
Explanation: Research aims to uncover causal relationships, determine the factors that
influence outcomes, and provide explanations for observed phenomena.
Goals of Research
According to Creswell (2014), the goals of research can be summarized as follows:
Prediction: Research endeavors to develop models or theories that can predict future
outcomes or behavior based on established patterns and relationships.
Application: Research aims to produce knowledge and findings that have practical
applications and can be used to address real-world problems, inform decision-making,
and improve practices.
Outline of the Research Paper
Outline of the Research Paper
Outline of the Research Paper
Avoid citing sources in your abstract. There are two reasons for this:
o The abstract should focus on your original research, not on the work of others.
o The abstract should be self-contained and fully understandable without reference to
other sources.
There are some circumstances where you might need to mention other sources in an
abstract: for example, if your research responds directly to another study or focuses on
the work of a single theorist. In general, though, don’t include citations unless
absolutely necessary.
Abstract Content
The abstract addresses the following
(usually 1–2 sentences per topic):
https://youtu.be/Hs5qVavUjwI
Lesson 3
Writing Feasibility Report
Objectives:
The plan could be putting up a printing press. What equipment/facilities are needed? An offset machine,
a letter press, a camera, a computer, a dark room, a stripping room, etc. Why is there a need for a
printing press? This is just the justification of the project. If the proponent is a school official, he can cite
the need for a school press to take care of the printing of books, the school organ, the yearbook, receipts,
enrolment forms, etc. How is the printing to be set up? The proponent can submit preliminary inquiries
on successful school printing presses and on availability of equipment/facilities needed as well as the
space for the printing press.
Writing Feasibility Report
The Cost
The estimated cost of the equipment and facilities entails a canvassing of the market.
What models are available and where? Are they second hand or brand new?
Source of Funding
If there is a provision in the school or company budget, the approval of the project is 50
percent sure.
If there is no allocation for the project, or if the allocation is not sufficient, is there a
possibility of getting loans from a bank? How much is the interest? Would the income from the project be able
to pay amortization on the loans when they are due?
One other source of funding is grants from funding agencies. However, if the project is
strictly a commercial venture, this source of funds is not to be considered at all.
Still another source is fund drives, usually resorted to by church and charitable organizations.
Writing Feasibility Report
Manpower or Personnel
How many persons are needed for the project? What are their job titles and job
descriptions? What salary is recommended for each? If the job is highly technical, has
the proponent scouted around for such technical people? If no technical people are
available, is there a possibility of training them here or abroad? A time table for the
recruitment of personnel is advisable and helpful.
Writing Feasibility Report
The Market
To whom will the commercial venture cater? Will there be enough clients or customers?
This component of the feasibility study should be supported by a survey. The viability
of the projects rests primarily on the stability of the market.
Profitability
The acceptability of the project will depend on whether or not it is profitable to be
undertaken. Economic profitability will call for a certain amount of return (10 to 20%)
on investment. If the project is not a commercial venture, there is a need to discuss how
the project will benefit a community or a specific group of people.
Writing Feasibility Report
LESSON 4
Making and Delivering Research
Presentation
Objectives
Visual Appeal:
Limited Text:
o Use bullet points or short phrases instead of full sentences.
o Present key ideas or keywords rather than detailed explanations.
o Use the presentation as a visual aid to supplement your oral
presentation.
Slide Design:
o Use a clean and uncluttered design with a consistent color scheme and
font style.
o Ensure text and visuals are easily readable from a distance.
o Limit the number of slides to keep the presentation focused and concise.
Slide Structure:
o Use a clear and logical structure with headings, subheadings, and
bullet points.
o Keep text on each slide concise and avoid overcrowding.
o Use consistent formatting for headings, text, and bullet points
throughout the presentation.
Data Visualization:
o Utilize charts, graphs, or infographics to present data.
o Choose the appropriate visualization type based on the nature of your
data.
o Ensure that data visuals are clear, labeled, and easy to interpret.
Consistency:
o Maintain a consistent design style throughout the presentation.
o Use consistent fonts, colors, and formatting for a cohesive look.
o Ensure that slide transitions and animations are used sparingly and
purposefully.
Transitions and Animations:
o Use slide transitions and animations sparingly and purposefully.
o Avoid excessive or distracting animations that can detract from the content.
o Ensure that transitions and animations enhance the visual flow of the
presentation.
Visual Aids:
o Utilize visual aids, such as slides or charts, to support and enhance
your presentation.
o Use visuals to clarify complex ideas, present data, or illustrate key
points.
Practice and Rehearsal:
o Practice your presentation multiple times to build confidence and
ensure smooth delivery.
o Time yourself to stay within the allotted presentation time.
o Rehearse in front of a mirror, friends, or colleagues to receive feedback
and make improvements.
Q&A Session:
o Prepare for potential questions by anticipating areas of
inquiry.
o Listen attentively to questions and provide clear and
concise responses.
Noteworthy for the Presenter
Author: Johanssen
Year of Publication: 2022
YOUR TASK 1: Comprehension Check