Module 3 Ginst Elective 001 Revised

GINST ELECTIVE 001
TECHNICAL WRITING
2ND SEMESTER , SY 2022-2023
THELMA G. BALORAN, MAED

INSTRUCTOR
THIS MODULE IS FOR THE EXCLUSIVE USE OF THE UNIVERSITY OF LA SALETTE, INC. ANY FORM OF REPRODUCTION, DISTRIBUTION,
UPLOADING, OR POSTING ONLINE IN ANY FORM OR BY ANY MEANS WITHOUT THE WRITTEN PERMISSION OF THE UNIVERSITY IS STRICTLY
PROHIBITED.
1
Module 3
Technical Manuals
INTRODUCTION
As technologies continue to develop, there is an increasing need for quality technical manuals.
Whether the product is a piece of software, hardware, mechanical device, or a technical reference on a
particular subject, there is a need for your technical writing skills.
I. LEARNING OUTCOMES:
At the end of module 3, you are expected to:
1. Compare the features of the different types of technical manuals through grid completion; Here it
is sir. describe the features of the different types of technical manuals;
2. explain the importance of technical manuals;
3. evaluate samples of technical manuals;
4. demonstrate technological skills in the preparation of a technical manual; and
5. reflect on a learning experience.
II. TOPICS
TECHNICAL MANUALS
 What is a Technical Manual?

 How to Write a Technical Manual
 The Importance of Having a Manual
 Classifications of Manual
 Why do we need a Manual?
 The Advantages of having Manuals
 Difference between a Manual and a Guide
 Differences between “manual”, “guide” and “instruction
INSTRUCTIONAL MATERIALS
Slide presentations on Technical Manuals

Sample Manuals
Graphic Organizers
III. KNOWLEDGE ACTIVATORS:
PROHIBITED.
2
 When you buy a gadget, an appliance, or anything that you will use, what is this that
you usually check and read? Why?
Concept Linkers
Examine these manuals:
PROHIBITED.
3
PROHIBITED.
4
PROHIBITED.
5
https://www.google.com/search?
q=picture+of+installation+manual&sxsrf=ALeKk02FLTNEOQQC94hcUzJcGOsstq9QVA:1595749345807&tbm=isch&sourc
e=iu&ictx=1&fir=qajD0UGdtOmeDM%252Cr0nGpgDU6z2DBM%252C_&vet=1&usg=AI4_-kQK84ZRXWBBRvGo3adrvHr-
QcQV9g&sa=X&ved=2ahUKEwi5z6DHterqAhUmBKYKHZAeBXIQ9QEwAHoECAoQBQ&biw=1280&bih=599#imgrc=qajD0U
GdtOmeDM
https://www.google.com/search?rlz=1C1CHBF_enPH892PH893&sxsrf=ALeKk03ZwE27g6-Ty-
vqpj7KGOpFfya0Hg:1595749602715&q=sample+manuals&tbm=isch&chips=q:sample+manuals,online_chips:user+manu
al&usg=AI4_-kQP3XK-
jDu2pQJm1uxJmMqmIlDsAw&sa=X&ved=2ahUKEwiLreHBturqAhUCMN4KHTEGAlgQgIoDKAJ6BAgKEAc&biw=1280&bih=
647#imgrc=CjaAB8VPuNP2rM
https://www.google.com/search?q=sample+picture+user+guide&rlz=1C1CHBF_enPH892PH893&sxsrf=ALeKk00-
7MdhZcpHiiBxBs1ltS8pclAAdw:1595750737281&tbm=isch&source=iu&ictx=1&fir=tsnWhFbwgcC2fM
%252CTAtzqkI3ss3OWM%252C_&vet=1&usg=AI4_-kRiZVVZMaD7c_hccHRMlKLVhryiFg&sa=X&ved=2ahUKEwiOx-
HeuurqAhUG7WEKHfR6AH0Q9QEwAHoECAgQBQ&biw=1280&bih=647#imgrc=tsnWhFbwgcC2fM
Think and Discover

1.What purposes do these manuals serve for?
2.Have you tried using other kinds of manuals? What are they? Why did you use them?
IV.INPUT
Getting to know the world of technical manual writing
What is technical manual writing? This all boils down to the question: what is a technical manual?
‘Technical manual’ is a term for any manual with a technical character. You could think of a manual (or set of
manuals) for a complicated machine like an airplane. You could also think of technical manuals to run a
complete industrial installation.
The word “technical” gets a bad rep. As soon as someone reads or hears the word technical, their mind
instantly starts to think about messy software code, endless instructions or steps, or command-line programs.
But let’s not get ahead of ourselves just yet. Let us first understand what we mean by a technical manual, why
writing such documents are important, and in the end, discuss an awesome documentation tool that will make
writing these boring documents, bearable! Read on…
PROHIBITED.
6
What is a Technical Manual? (Definition)
According to Business Dictionary, is defined as a document containing instructions for installation, operation,
use, maintenance, parts list, support, and training requirements for the effective deployment of equipment,
machine, process, or system.
Phew, that was a mouthful!
In simple words, a technical manual is a document created for a single objective of making it simple for the
end-user to understand how a product or service, they are using works.
Describing the nuts and bolts of a product, technical manual acts as a “how-to” guide for your customers to get
them up to speed with the product they are using and help them solve any challenges they are facing while
using it.
Such documents involve product-related knowledge and data, how to use it, and what to do in case you run
into trouble. A few decades ago, technical manuals were in fact, way too technical for the common user to
comprehend.
As a result, companies were bombarded with customer calls and messages day and night, with angry and
frustrated customers at the other end.
A lot has changed since then. Technical manuals nowadays are written in a way that’s easy to read and
understand. They are written with the sole purpose of helping customers solve their problems themselves,
providing faster query resolution to the customer, and less overhead to the business.
https://blog.bit.ai/technical-manual/
Ten considerations
How to write a technical manual? Technical writing always brings with it ten considerations that any
technical writer should be aware of.
1. Know who you are talking to

 Manual writing expertise is first and foremost: knowing who you are talking to. The tone of
voice for elderly people using a tablet has to be quite different from a mechanic who knows his
way around in a chemical plant.
2. Be aware of all directives

 When a product is faulty in some way, the manufacturer or reseller can be held accountable for
its consequences. ‘Faulty in some way’ is indeed the right expression, since European directives
also include requirements for writing technical manuals (or any manual for that matter). This
means that your technical manual is also subject to scrutiny. A manual is an integral part of the
product and could lead to legal liability!
3. Follow the guidelines

 Legal requirements or directives are all fine. But how do you know that you meet those
requirements? Fortunately, there are guidelines. These guidelines may have a national origin.
However, they do not differ much between, say, Germany and the Netherlands. Of course, one
PROHIBITED.
7
should be aware of these guidelines. They tell you what kind of chapters to include what size the
letters should be and so on.
4. Collect all the information that you can

 It is better to choose from too much information than risking the chance that your technical
manual (or not so technical manual) is incomplete. CAD illustrations? Marketing
documentation? They all provide context and therefore should be an integral part of manual
writing
5. Write effectively
 How to write a technical manual effectively? By using the manual writing expertise that you
have at your disposal. There are at least three principles that lead to effective manual writing:
Simplified Technical English (STE), minimalism and topic based authoring.
 Simplified Technical English is a specific standard, simplifying the use of the English language
in technical documents by putting a limit on the number of words in a sentence. Also, the set of
words is restricted (‘to do’ is easier to understand than ‘to carry out’).
 Minimalism is a way of thinking. This way of thinking is: only provide information that is really
useful. An example coming from the aviation industry springs to mind. When there was a loss of
pressure in an airplane, the emergency manual – in effect a checklist – started with telling that
something might be wrong with a valve. This certainly is a false start. The first sentence should
have been: “Put on your oxygen mask.” Minimalism could have saved lives here, since the pilots
did not feel inclined to put on their oxygen masks. And the checklist did not tell them to do so.
Minimalism tells us we should concentrate on our tasks, not on information that can be
provided later on (or is not necessary at all).
 Topic based authoring means that writing (technical) manuals comes down to writing building
blocks that can be reused in other or newer technical manuals. For example, the chapters or
sections ‘Safety measures’ and/or ‘Maintenance’ could be identical in different manuals. By
writing topic based, instead of writing in a linear fashion, information blocks become readily
available all of the time.
 Using these three principles will shorten training times for mechanics with as much as 30%.
Users can absorb 25% more information as a consequence of bringing the three writing
principles into practice.
6. Use pictures
 Writing technical manuals should not only include… manual writing. Even better still: writing
technical manuals should preferably not entail writing manuals. If a picture tells you more
than.1,000 words, the illustration should take preference. An illustration can be far more
effective if you want to get your message across. Illustrations may also be more cost effective to
produce. At any rate, translation of a picture will not be necessary.
7. Use animations
PROHIBITED.
8
 When a user has to carry out a lot of similar actions (holding the top of a bottle while moving the
rest of the bottle to the left, then putting the bottle upside down and so on), a series of
illustrations might be effective. But an animation might be the extra option you are looking for.
8. Translate and …localize

 It could be that your manual needs translation, if only because of European directives. It goes
without saying that texts in a local language are also very user friendly: almost everyone likes to
be addressed in his or her own mother tongue.
 Translation should be more than replacing words. It should also entail ‘localization’. What does
‘localization’ in a manual mean? It means that for users on the European continent the steering
wheel of a car should be drawn on the left-hand side, whereas for UK users it should be on the
right-hand side. To you give just one example.
9. Build your archive

 It is important to use content management software with which you can build your own archive.
This way, you can easily use and reuse existing information blocks.
10. Publish in any (additional) shape or form
 Why is a content management system so enormously important? Because you can reuse existing
information blocks in every output channel imaginable: print, online or offline on a device (by
means of a PDF file, for example). Online or offline presence also makes it possible to use 3D
animations.
https://www.manualise.com/en/write-technical-manual/
How to Write a Technical Manual Easily and Effectively: Step by Step
Now that you know the importance of creating a technical manual for both your employees and customers, its
time to get into the nitty-gritty of actually writing a technical manual. While most technical manuals out there
can be boring to read, making them attractive, interactive, and interesting can do wonders for your brand to
stand out and make a good impression on your customers. Follow these simple steps to create an amazing
technical manual:
Step 1. Determine your audience
The first and most important step to create a technical manual is to define your audience. The more you know
about the end-user, the better you will be able to understand and predict their challenges. In turn, you will be
able to create a technical manual that is helpful and in-line with what the reader expects.
Step 2. Define the outcome

Define how the end-user will benefit from reading the technical manual and what will they achieve after doing
so. When your readers know exactly what to expect from the manual, the buy-in goes up significantly.
Having the end-result in mind will also help you write the manual better, with your objective as your north-
star.
Step 3. Gather requirements
PROHIBITED.
9
Next, you need to gather requirements for your technical manual. What are the frequently asked questions by
customers? Where do most customers face issues or challenges? These are the questions you need to answer
before kickstarting your technical manual documentation.
A great point to start is to bring together your customer service reps and sales staff under one roof and ask
their suggestions and feedback. Since they are the ones who interact with the customers the most, they have
the most in-depth insights into customer wants and needs.
You can also conduct an online survey with your existing customers and ask them about their pain points. You
can then address these pain points in your manual and improve customer satisfaction substantially.

Step 4. Create an outline
Technical manuals can be lengthy. It helps if you first create a structured outline and follow it religiously. From
your requirements gathering phase, list down your main points you are going to cover in the manual and divide
them into headings, sub-headings, categories, sub-categories, or topics. Not only will it be easier for your team
to create technical manuals, but it will be easier to browse for the end-user as well.

Step 5. Make it interactive
Most technical manuals are filled with plain-boring text and technical jargon no one reads. This leads to
dissatisfied customers. Make your technical manuals interactive by adding images, videos, infographics, and
more wherever it makes sense.
Since humans are visual creatures, we all understand better when we have a visual context around something
we are reading. If you explaining something in steps, adding screenshots to guide the customers to the end-
point can do wonders.

Step 6. Proofread
Before you hit “publish”, make sure you have re-read the entire thing. It helps to get an additional pair of eyes
to go through it and make sure you haven’t missed out on anything. Accuracy is key as it can make or break
your customer experience.

Step 7. Keep updating
Technical manuals are live documents that require constant updating. These are not one-off documents you
can create and forget about. Once you publish your technical manual, make sure to do a survey or follow up
with the end-user on the effectiveness of the manual, and understand the things they like and dislike.
Moreover, whenever your product releases a new feature, there needs to be an added entry in the technical
manual explaining it.

PROHIBITED.
10
The Importance of Having a Manual
In our everyday life, we have got on hold of a manual, with or without taking notice. Whether it is how
to install software or how to use our mobile phones or how to run a business. Manuals have been a part of our
lives.
For start ups, you might be wondering whether having a manual is necessary or how to make one. Let
me inform you that having a manual is a big step in growing your business. Know that, not many documents
are as important as a manual for any type of business.
Just for example, you’ve bought the latest iPhone 6, there was a manual on how to use this model. Like
in business, you need to have a manual on how to operate the business, how to make the product, how to give
good customer service, how to make a balance sheet, and so on.
In business, the Manual of Operations relay the standards and procedures of the company.
It is a useful guide for the company to set the standards of the various operations within different
departments.
There are a variety of manuals depending on the industry or purpose. Below is an overview of the
different types of manuals.
Classifications of Manual
 Product Manual
This is also called the “Instruction manual”. It is a manual that instructs users how to use
the product.
 Installation Manual
This is a manual on how to set- up or install the product.
 Troubleshoot Manual
A type of manual used to fix parts of the product.
 User Manuals
A type of manual that focuses on different kinds of users- administrators, maintenance
personnel, beginners, managers, or students
 Operations Manual
This is the manual for operations of the company or businesses. It is a set of standards and
procedures for operations, work standards, and policies of the company.
 Crisis Management Manual

A manual on how to respond to crisis or tragedies such as earthquake, fire, storms,
tsunami, or violence in the work premises.
PROHIBITED.
11
 Audit Manual
This type of manual is a guide on how to do or make finance reports in relations to
accounting and auditing matters.
Different Types of Technical Manuals and their Uses:
Following are the types and areas of documentation created to achieve the demands of different people using a
product or technology:
 Customer support manuals: Technical manuals are primarily made for the customer of a product.
These documents can take the form of an online wiki, help desk articles, training manuals, customer
support handbooks, user guides, release notes, installation manuals- basically any document that helps
the end customer.
 Organization support manuals: These can include documents that help an employee do their work
effectively in an organization. For example, procedures doc, reference guides, maintenance and
troubleshooting manuals, employee handbooks, and more.
 Marketing support manuals: Such documents help your team (marketing and sales departments)
to market your product and are product-focussed. For example, product explanation videos,
infographics, landing pages, and more.
 IT support manuals: It support documents are used to help guide IT teams, to do their job
efficiently. These can include technical specifications of a product, glossaries, software development,
etc.
Why do we need a Manual?

Manuals are universal documents that can be understood by ordinary people. It explains certain operations
and processes of different departments. With a manual, company can have a standard for its operations. Then,
why do we need manuals?
 Avoid Information Gap

-Manual gives consistency to the company. It gives us instructions and guidelines on how to do a
certain thing or job. For example, when an employee is promoted to managerial position, manuals give
him/her the overview of the roles and responsibilities of that position.
 Launching of new products or services

-When you make a new product or service, you need to provide a Manual that contains the how-
to’s, components, functionality, and processes.
 Valued Customers
-For customers to gain information about the product. And for consumers to understand the
product well and how to get the utmost benefits from the product.
PROHIBITED.
12
 Valuable Tool
-Manual is a valuable tool for understanding technical knowledge in fields such as law,
construction, and finance. It is especially important for consumer electronics products, medical
equipment, construction machinery, computer and its accessories.
Furthermore, this type of manual is a guide on how to do or make finance reports in relations to accounting
and auditing matters. Today, an online business also requires an audit for the website. Technical audit allows
you to identify errors related to the operation of the hosting and software code of the company’s website. The
solution of technical problems is the basis for the subsequent successful promotion of the project in search
engines. It is necessary to use tools such as Sitechecker.pro to audit the site in order to understand the main
shortcomings and correct them. Based on the audit, an action algorithm has been created that will promote
your resource to the TOP search results.
Benefits of Formulating a Manual

In the process of making a manual, information in different departments of the company will be
collected and organized. It will also make us aware of the different functions, processes, rules, and operations
of the company and the interplay and collaboration between different departments.
The advantages of having of Manual are as follows:
 Reduced Time and Cost to Productivity

We can improve the quality of our products and services. There will be lesser complaints and
clarifications regarding how to use or how to install our products.
 Shared Information
We can share knowledge and wisdom which are compounded before to only one person or department.
For new employees, this will also reduce the time for their training since the Manual would give them
the standards and procedures they need to abide by. It will also give the employees a general overview
of how the company operates and their respective roles and responsibilities.
 Reduce and Minimize risks (Risk hedge)

Businesses can avoid having misconceptions or misunderstandings; Having a Manual sets the rules,
guidelines and policies of the company operations.
Manual also set the standards for the company to ensure profitability and growth.
 Maximize potentials
Manuals are universal to the company. For example, when a business outsources certain functions, a
Manual provides consistency and quality assurance. Referring to a Manual increases the productivity
and profitability of the company
 Avoid “Knowledge trap”

Having a manual avoids “knowledge traps”. This means information or processes that is only known to
one specialist or experts in that field. Worst case scenario in any company is having only one person
who knows this knowledge or skill and is capable in doing that particular role or job.
PROHIBITED.
13
Thus, manuals are an essential tool to avoid knowledge traps. Since manuals explains in layman
terms, any technical data or information of that specific department or field of work, which can be understood
by ordinary people. Having said this, manual can relays knowledge and information to staff, thus, improving
work performance and productivity.
https://foundersguide.com/manual-of-operations-helpful-tool-for-business/
Difference between a Manual and a Guide

Sharma (2020) highlighted that there are misconceptions and considerable overlaps between these
two words user manuals, and user guides. When it comes to definition, in some positions, they can be
interchangeable. These two worlds can be coupled together or can be associated with other terms as well,
such as a reference guide or instruction manual.
In Sharma’s article titled: “Difference Between A Manual and A Guide?” there were things mentioned as to
the differences that set them apart and make them unique. They are as follows:
Manual
 A manual is a specific reference book or document where you can find all the detailed information
about a product along with its operation, maintenance, use, safety and other things the product may
come with. The product’s manufacturers usually provide a manual with every product they make and
launch into the market. It works as an assistant for the user of the product if the user doesn’t have
any prior idea on how to operate or use the product and take care of it. It also refers to the user how
to take care of it and keep safe while operating, if the product comes with any safety precautions.
These are often called the official user manual.
Guide
 Now, a guide is more of a generic term if you compare it to the definition of Manual. When user
manuals usually come with a physical, non-physical or digital product, and it comes with detailed
documentation about the product, a guide can be as simple as just a card or a few minutes’ videos. A
guide can be both for a product or something else like how to buy a product! It can be referred to as a
PROHIBITED.
14
teaching method where you’ll have an overall idea about doing something. There is even no need to
have any product to get a guide. A guide just leads you to a destination where a product makes
clarifications and documentation.
Types of manual
There are different Derived terms and types of manuals for different perspectives, such as Instruction
manual, reference manual, product manual, working manual, Owner’s manual or User manual and so on.
Types of guide
There are some different types of the guide too. Such as User guide, Career guide, Tour guide,
Guideline or guidance. All these types of Guides perform the same thing; they lead you to the objective and
talks about how to do the job.
Key difference
Although the main objective of both manual and guide is to provide some instruction, there are some
key differences between these two. Such as:
Coverage
A manual will describe all the features of a product in a certain manner and will tell you the technical
terms of how to use those features and how to maintain the product. Manuals usually come with machinery
products, consumer products, electronic devices that need a special hand to assemble, operate and taking
care. The product manual will work as a virtual technician from the factory. So, it has to be very extensive, so
the user doesn’t get into a maze of wires and safety hazards.
A guide will tell you about the product in short and only how to use it, not how to repair it. The guide
can tell you how to get started with the product, it may include some basic features that are needed to get
started with it, but the in-depth instruction is found in the manual, not the guide.
Look and format
When you will look at a manual, it usually comes as a written book format where the detailed
descriptions are more elaborated in a formal way that speaks for the professionalism of the manufacturer.
PROHIBITED.
15
But a guide can be anything, like a written book or a little card, a simple note, audio you can find
online or a video you can watch anywhere. The guide is more of a simple and informal presentation of any
product.
Examples
If I get the dilemma into account and try to elaborate in simple words, say you brought a sewing
machine that comes in unassembled. You will have to open up the manual book and go through the
instructions to assemble it and set it up on the space you want.
But a guide may not even come with the machine in the box! You can go online and ask someone how
they use the same machine! Someone just sent you a video wherein he/she told you to get the power cord
into the wall socket and hit the power-on switch. get the cloth under the needle and keep the line steady. and
that’s a guide, easy and simple.
Conclusion
To wrap up the difference between manual and guide, take this away: when you are about to repair
your laptop, you’ll be looking for user manuals and when you just want to know how to use a laptop, you’ll
be looking for a laptop-using guide.
http://acquirosolutions.com/blog/Business/details/199/Difference-Between-A-Manual-and-A-Guide
Is an instruction guide different from a manual?
The essence of instruction guides
Is an instruction guide different from a manual? The short answer is: no. The long answer is: more or
less. This article explains why an instruction guide somehow has its own character. In principle, the differences
are really minor though.
An instruction guide shares the word ‘guide’ with the term ‘quick start guide’. This is telling. An instruction
guide does not count that many pages. Its compactness could be compared to a quick start guide, which main
focus is on the working instructions itself. This focus on the instructions itself is also prevalent in an
instruction guide. This has to with the relative simplicity of the products for which one writes an instruction
guide. These products do not involve much maintenance or safety issues. Take a calculator or a flashlight.
PROHIBITED.
16
This being said, there are a lot similarities between an instruction guide and a manual. These
similarities mainly have to do with the phrasing of the instructions. Instructions should be phrased in the same
way as in any manual, even the rather complicated ones like maintenance manuals.
What does ‘phrasing the same way’ mean here? It means a couple of things.
1. Using imperative sentences
Instructions should be as compact as possible. This means using imperative sentences: “Put on the light”
instead of “Now, you can put on the light”. Imperative sentences are not only compact, there are also
unambiguous. If a user would read “Now, you can put on the light”, he might ask himself whether putting on
the light is really necessary. A technical writer should not leave his wording open for interpretation. He should
be as precise and as compact as possible.
2. Dividing different tasks
Replacing a battery is something different from switching off and on a flashlight. Cleaning a flashlight is
something different altogether. In order for the user to scan each task properly, one should separate these tasks
from each other as much as possible (“Replacing the battery”, “Switching the flashlight on or off” and so on).
3. Incorporating pictures
If anything, pictures are even more important in an instruction guide than in a manual – although there are
absolutely useful in both instances. A picture can convey information in an instant, which is particularly
important in a compact manual as an instruction guide in effect is. If a picture can tell you more than even 100
words (instead of 1,000), one should prefer imagery instead of text.
All in all, instruction guides are not that different from manuals. Especially not if one knows how to
phrase the instructions themselves.
https://www.manualise.com/en/instruction-guide-different-manual/
What are the differences between “manual”, “guide” and “instruction”?

There is considerable overlap among the three, and to some extent they can be interchangeable. They
can be coupled together or with other terms, as in instruction manual or reference guide. In addition,
there are a number of similar terms like handbook, guidebook, primer, or vade mecum.
Manual refers specifically to a reference document which provides detailed information about
operation and maintenance of a product. Manufacturers will often provide an official manual for a
product to provide assistance to its owners or users: cars, for example, usually come with an owner's
PROHIBITED.
17
manual, machinery with an operator's manual, and official documentation for Unix programs
with manual pages.
Guide is a more generic term. Whereas manual implies a written document, one that could be a
booklet for a video game or a large book for a complex product such as a car, a guide can be just a
card, or in another medium altogether such as a video. It may be a detailed reference, but it can also
indicate a very simple overview or instructions for a small subset of features.
Because "manual" has connotations of dense, boring text, some manufacturers or technical writers
prefer the label "guide" for what would traditionally be called a "manual."
Instructions is the most generic term, and may be synonymous with directions— step-by-step
guidance on how to perform a specific task or function. A manual or guide will include many sets of
instructions. Used alone, however, "instructions" can refer to the simplest explanatory text— push cap
and twist to open, or use other door.
Manual is the official, comprehensive reference to the operation and maintenance of a product or
device. Manuals may also provide conceptual information, such as design theory. Some "all-in-one"
manuals are comprehensive enough to include information that would otherwise be found in separate
guides or instructions, such as usage scenarios, diagnostic procedures, installation instructions, etc.
Guide coaches the user on how to use a product effectively and efficiently, typically by providing
application examples and usage scenarios. Some marketing professionals prefer using the term
"guide" instead of "manual" without regard for this distinction because "guide" sounds helpful and
easier to read.
Instructions are simply procedures (presumably tested procedures) for accomplishing specific tasks.
The instructions can be contained in a manual or guide, or they can be standalone documents such as
instruction sheets for assembling furniture or replacing a battery.
Manual is related how to operate something (usually an electronic device). The word comes from
Latin “manus” hands and in this context means operates something with your hands.
Guide gives us the idea of introducing some device giving all the aspects and capacities as if you were
doing a tour to know each delightful task that your device can do.
Instructions are related to give you instructions for you do a given task then you should follow strictly
the instructions to performance well an activity.
In summary:
Manual focuses on the (Object device): How to operate it.
Guide focuses on all the capacities of the device.
PROHIBITED.
18
Instruction focuses on leading you to do determined tasks on a device.
https://english.stackexchange.com/questions/59224/what-are-the-differences-between-manual-guide-and-instruction
For further understanding visit the following links:
https://medium.com/@kesiparker/technical-documentation-vs-user-documentation-ff68e7de1985
https://edit911.com/8-steps-in-writing-technical-manuals/
http://www.differencebetween.info/difference-between-manual-and-guide
https://trijsolutions.com/organizational-knowledge-blog/whats-the-difference-between-procedures-and-user-guides/
PROHIBITED.
19
Comprehension Check:
A. Compare manual, guide and instruction by completing the grid below with the needed details.
Describe manual, guide and instruction by completing the grid below with the needed details.
BASIS MANUAL GUIDE INSTRUCTION
1.Definition .
2.Description
3.Purpose
4.Types
PROHIBITED.
20
5.Example
B. Explain why technical manuals really matter? Support your answer?
Tasks
1. (Portfolio of Technical Manuals) Collect sample of technical manuals in line with your course/
field. At least three of each kind. Evaluate each manual as to the following: Description, Type
and Purpose. Present your findings.
2. Write one sample of a technical manual. It could be related to your course or to any chosen
field that interest you.
RUBRIC FOR THE PORTFOLIO
Excellent (4) Good (3) Satisfactory (2)

Needs
Improvement (1)
All directions were You followed most You followed None of the
Following Tasks followed directions some directions directions were
Directions followed
Use of Creativity You use your own You used your You used some You did not use
ideas and own ideas most of imagination. your own ideas
imagination. the time. and imagination.
Effort put into You took your You worked hard You put a small You rushed
the output time and worked for most of the effort into the through and did
hard on the time. output. not work hard.
output.
RUBRIC FOR THECHNICAL MANUAL

VGE GE SE LE N
(5) (4) (3) (2) (1)
CONTENT
PROHIBITED.
21
1. The manual is well-organized.
2. The manual has clarity of ideas.
3. The manual has proper grammar

PRESENTATION
4. The manual uses pictures,

illustrations or animations.
5. The manual is simple yet complete.
6. The manual is user friendly.

Legend: VGE-To a very great extent; GE-To a great extent; SE- To some extent; LE- To a little extent;
N-Not at all
V.INTEGRATION/REFLECTION
Reflect on the learning that you gained from this lesson by completing the given chart.
What were your misconceptions about What new or additional learning have
the topic prior to taking up this lesson? you gained from this lesson in terms of
skills, content, and attitude?
I thought… I learned that…
PROHIBITED.
22
VI.SUMMARY:
In this module, you learned that technical manuals play a vital role in any one’s life. For them to
be considered as well-crafted, they are created with the end-user in mind, are interactive, and are easy
to read and understand.
VII.REFERENCES:
Websites/Links
 Baldwin,M.(2013,March 6).8 Steps in Writing Technical Manuals.Retrieved

fromhttps://edit911.com/8-steps-in-writing-technical-manuals/
 Difference between Manual and Guide.Retrieved
fromhttp://www.differencebetween.info/difference-between-manual-and-guide
 Emily(2020, February 24).Difference Between A Manual and A Guide?REtrieved
fromhttp://acquirosolutions.com/blog/Business/details/199/Difference-Between-A-Manual-
and-A-Guide
 How to write a technical manual.Retrieved fromhttps://www.manualise.com/en/write-technical-
manual/
 Is an instruction guide different from a manual?Retrieved
fromhttps://www.manualise.com/en/instruction-guide-different-manual/
PROHIBITED.
23
 Makoto,M.(2020,February 20).Manual of Operations: Key for Knowledge
Management,Retrieved fromhttps://foundersguide.com/manual-of-operations-helpful-tool-
for-business/
 Parker,K.(2014,July 5).Technical Documentation vs User Documentation.Retrieved
fromhttps://medium.com/@kesiparker/technical-documentation-vs-user-documentation-
ff68e7de1985
 (2021).Technical Manuals: What, Types & How to Ceate One?(Steps Included)Retrieved from
 What are the differences between a “manual”, “guide”, and “instructions”?Retreieved
fromhttps://english.stackexchange.com/questions/59224/what-are-the-differences-between-
manual-guide-and-instruction
Name_______________________ Course/Year & Section______________
MODULE 3
TECHNICAL MANUALS
Knowledge Activators
 When you buy a gadget an appliance or anything that you will use, what is this that
you usually check and read? Why?
Concept Linkers
Examine these manuals.
Think and Discover

1.What purposes do these manuals serve for?
2.Have you tried using other kinds of manuals? What are they? Why did you use them?
Comprehension Check:
PROHIBITED.
24
A. Describe manual, guide and instruction by completing the grid below with the needed
details.
BASIS MANUAL GUIDE INSTRUCTION
1.Definition .
2.Description
3.Purpose
4.Types
5.Example
B. Explain why technical manuals really matter? Support your answer?
Tasks
PROHIBITED.
25
1. (Portfolio of Technical Manuals) Collect sample of technical manuals in line with your course/
field. At least three of each kind. Evaluate each manual as to the following: Description, Type and
Purpose. Present your findings.
2. Write one sample of a technical manual. It could be related to your course or to any chosen field
that interest you.
RUBRIC FOR THE PORTFOLIO
Excellent (4) Good (3) Satisfactory (2)

Needs
Improvement (1)
All directions were You followed most You followed None of the
Following Tasks followed directions some directions directions were
Directions followed
Use of Creativity You use your own You used your You used some You did not use
ideas and own ideas most of imagination. your own ideas
imagination. the time. and imagination.
Effort put into You took your You worked hard You put a small You rushed
the output time and worked for most of the effort into the through and did
hard on the time. output. not work hard.
output.
RUBRIC FOR THECHNICAL MANUAL

VGE GE SE LE N
(5) (4) (3) (2) (1)
CONTENT
1. The manual is well-organized.
2. The manual has clarity of ideas.
3. The manual has proper grammar

PRESENTATION
4. The manual uses pictures,

illustrations or animations.
5. The manual is simple yet complete.
6. The manual is user friendly.
PROHIBITED.
26
Legend: VGE-To a very great extent; GE-To a great extent; SE- To some extent; LE- To a little extent;
N-Not at all
Integration (Reflection)
Reflect on the learning that you gained from this lesson by completing the given chart.
What were your misconceptions about What new or additional learning have
the topic prior to taking up this lesson? you gained from this lesson in terms of
skills, content, and attitude?
I thought… I learned that…
PROHIBITED.
27
Remember this line po:
“Our fingerprints don’t fade from the lives we touch.” -Judy Blume
Kindly check and consider some minimal corrections made to this module po. Feel free
to ask me if you have questions about these corrections po.
PROHIBITED.
28

Module 3 Ginst Elective 001 Revised

Uploaded by

Copyright:

Available Formats

Module 3 Ginst Elective 001 Revised

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Module 3 Ginst Elective 001 Revised

Uploaded by

Copyright:

Available Formats

GINST ELECTIVE 001

2ND SEMESTER , SY 2022-2023

THELMA G. BALORAN, MAED

At the end of module 3, you are expected to:

 What is a Technical Manual?

Slide presentations on Technical Manuals

III. KNOWLEDGE ACTIVATORS:

Think and Discover

1. Know who you are talking to

2. Be aware of all directives

3. Follow the guidelines

4. Collect all the information that you can

8. Translate and …localize

9. Build your archive

Step 2. Define the outcome

 Crisis Management Manual

Different Types of Technical Manuals and their Uses:

Why do we need a Manual?

 Avoid Information Gap

 Launching of new products or services

Benefits of Formulating a Manual

The advantages of having of Manual are as follows:

 Reduced Time and Cost to Productivity

 Reduce and Minimize risks (Risk hedge)

 Avoid “Knowledge trap”

Difference between a Manual and a Guide

Look and format

Is an instruction guide different from a manual?

The essence of instruction guides

1. Using imperative sentences

2. Dividing different tasks

What are the differences between “manual”, “guide” and “instruction”?

For further understanding visit the following links:

BASIS MANUAL GUIDE INSTRUCTION

B. Explain why technical manuals really matter? Support your answer?

RUBRIC FOR THE PORTFOLIO

Excellent (4) Good (3) Satisfactory (2)

RUBRIC FOR THECHNICAL MANUAL

3. The manual has proper grammar

4. The manual uses pictures,

5. The manual is simple yet complete.

6. The manual is user friendly.

I thought… I learned that…

 Baldwin,M.(2013,March 6).8 Steps in Writing Technical Manuals.Retrieved

Name_______________________ Course/Year & Section______________

Think and Discover

BASIS MANUAL GUIDE INSTRUCTION

B. Explain why technical manuals really matter? Support your answer?

RUBRIC FOR THE PORTFOLIO

Excellent (4) Good (3) Satisfactory (2)

RUBRIC FOR THECHNICAL MANUAL

3. The manual has proper grammar

4. The manual uses pictures,

5. The manual is simple yet complete.

6. The manual is user friendly.

I thought… I learned that…

You might also like

Name_________ Course/Year & Section