LOGO COMPANY
GUIDE FOR THE PREPARATION OF THE TRAINING MANUAL Code:PR-725-01
Process: MANAGEMENT OF IMPLEMENTATION
Issue Date: day/month/year Review: 00 Edition: 01 Page: 1/2
Guide for the development of the training manual
Before starting to write a manual, it is necessary to determine what type of user is...
will enable, to identify the average profile of the target customer for the training and finally
consider the processes that the system covers for teaching.
The training manual is a guide to follow during a course or seminar.
"training" is a reference to some system or module for later on.
Once completed, it becomes a general reference for the user.
Steps to follow to write training manuals:
The starting point is to know the level of knowledge and experience of the
target audience of the manual, regardless of the system or module to be included
in the manual.
To reach any type of user, it is necessary to use a language
common, language that should not include overly technical terminology.
Additionally, the business language used by the client will need to be utilized.
to facilitate their learning.
3- When detailing the different options of the system, it is essential to describe
supporting information (such as completed information forms, reports or
queries). New users (those who have never had contact with a
system) not only need to know what the system or the module is, additionally
We will need to explain how to use it in everyday life. If the latter is not achieved, it will not be included.
In the manual, during the training provided, concrete examples of the 'day-to-day' should be given.
client's day and how they should interact with the system.
4- Use high-level terminology and less supporting information for groups
clients who have already been clients of the company or have already used systems
previously. In general, existing users of the system or product need
to know only the new features.
5- Introduction to the manual:
a. Describe the structure of the client company and the processes it covers
system to be implemented.
b. Detail the roles and responsibilities of both parties.
It is imperative to describe the standard operating procedure, the rules
general reports such as work reports, procedure for reporting
errors and externalize doubts. In general, one should not assume that the user
master the terminology of your business (it is expected that 80% of it is known), in
many times the users will be new employees who have just
They know the companies where they are just starting their work.
6- Description of each process that the system covers. It will be necessary to group the
processes in "sections", each section must include an introduction, Detail the
LOGO COMPANY
GUIDE FOR THE DEVELOPMENT OF THE TRAINING MANUAL Code: PR-725-01
Process: IMPLEMENTATION MANAGEMENT
Issue Date: day/month/year Review: 00 Edition: 01 Page: 2/2
the objective of the options that the process covers and therefore the section. It is
It is advisable to use summary guides so that the user can find their way.
quickly (let's remember that many of our fellow citizens read the
introduction and they believe they have written the book") and therefore will not read everything the
manual.
In each chapter, it is very important to start with action expressions,
like the verbs in the present indicative. Example: Enter the menu of
parameter registration, Verify that the selected option ...
b. When detailing instructions, they should be short and concise. All
expansion and/or clarification must be detailed in separate notes with the
object of concentrating the instructions and for the user to maintain their
attention in a fluid description from start to finish of the process.
c. In the case that an activity can be performed in two ways in
different options, the user should be warned about these alternatives that
It has to carry out the activity that has two paths, this point must be
clarify by explicitly and in detail relating the options to one another
so that the user does not get confused when finding 'accidentally' the
alternatives. Include screenshots, if applicable.
d. Copies of forms and reports (with information that the
users should be able to interpret), forms or should not be included
blank reports, because they do not reflect the activity carried out with the option.