Course Introduction
As organisations, their processes and their products grow increasingly
more complex, the ability to communicate specialised knowledge clearly
and effectively has become more necessary than ever before. Technical
communicators function as interpreters, translating complicated
technical information into language that almost anybody can understand.
They produce documents ranging from user manuals and FAQs to service
level agreements and functional specifications, in both printed and
electronic form.
The FTI Diploma in Technical Writing & Communication develops the
skills needed for business writers to plan, produce and manage
technical documentation to satisfy a variety of purposes and audiences.
This involves tasks such as identification of purpose and audience,
information gathering and analysis, document design, writing, usability
testing, editing, publishing and revision, and may involve
collaborative work with other writers and business units.
The diploma begins by examining the roles and responsibilities of
technical writers within organisations. A general framework for
technical writing is then constructed, based on the elements of
audience analysis, purpose identification, document structure, content
and style. Delegates use this framework to analyze and produce a
variety of technical communications, each with a specific audience and
purpose in mind. This provides a flexible approach to writing which is
easily accommodated within an organisation’s existing documentation
standards. Later seminars address a number of technical, legal and
social issues relating to document production and management within a
business environment, such as version control, copyright, and writing
for translation.
Although the diploma is not intended to teach English grammar or
spelling, common language problems are identified and writing style is
improved. In technical writing, how you write is as important as what
you write. Collaborative work ensures that delegates are exposed to
different styles and points of view, while individual assignments are
used to strengthen delegates’ analytical and writing skills. The final
project integrates theoretical knowledge and practical skills, and can
become a significant component of a delegate’s portfolio.
Technical communication is a challenging and rewarding career, which
can be practiced within any knowledge area. In 2006, Money Magazine
rated Technical Writer as the 13th best job in the US, rated on salary,
job prospects, flexibility, creativity, difficulty and stress level (money.cnn.com).
Demand for skilled technical writers continues to grow in fields such
as health, finance, manufacturing, IT and government. Anybody whose job
involves technical writing, or who intends moving into this area, will
benefit from attending this course.
Duration
The course begins with 2 full-day sessions, followed by 11 afternoon/evening seminars,
and is spread over approximately 20 weeks (depending on the course schedule). A roughly equivalent amount of time will be spent by delegates doing reading, preparation exercises and assignments.
An optional revision workshop will be held before the final examination
Target Audience
The course will be of direct benefit to those whose job functions
currently include technical writing, but who have no formal
qualifications in this field; and also people with broad experience of
business writing who wish to move into the specialised area of
technical communications.
Typical delegates include
-
Technical experts e.g. product specifications, user manuals, project
plans
-
Business managers and consultants e.g. strategy documents, business
proposals, progress reports
-
Writers with experience in other areas such as journalism or
marketing, who wish to move into the field of technical communication
Course Delivery
The course comprises instructor-led training, supplemented by readings,
exercises and practical group work. Assignments, based on case studies
and real-world business documents, ensure that the delegate is able to
apply the skills within the workplace.
Course Objectives
By the end of this course, delegates will be able to write effectively
across a range of technical communication genres by
-
analyzing the purpose of a communication and its intended audience;
-
developing persuasive arguments based on relevant and logically
structured information;
-
using language that is appropriate, correct and unambiguous;
-
applying efficient document production and management practices in
the workplace.
Course Prerequisites
Candidates may come from a wide variety of backgrounds, but should be
able to express themselves competently in English, should be familiar
with the use of a word processing program (such as MS Word), and should
have prior experience of writing business or technical documents. We do
not exclude any delegate who is strongly motivated to do the course, so
there are no strict pre-requisites.
Successful technical writers are likely to enjoy writing, have good
people skills, be logical thinkers, and pay attention to detail.
To get the most value out of the course, it should be done at the right
time in a person's career. Delegates and their companies will derive
maximum benefit from the learning experience if they meet the following
criteria:
-
They are currently working at a supervisory or management level; or
their job function includes writing of technical documentation or
proposals/reports.
-
They have previously undertaken a (fairly) significant documentation
project.
-
They have the active support of their managers (and in their home
life).
-
They have a mentor, guide or coach within the company.
-
They have ready access to a PC for course assignments.
Course workload
Delegates on the Diploma will need to:
-
Attend 13 seminars, which will help delegates to familiarise themselves with relevant concepts and techniques and to practice their application.
-
Read course notes and handouts, to add richness and understanding.
-
Complete preparation exercises prior to each seminar.
-
Complete 2 real-world assignments and a technical documentation
project to develop practical understanding and expertise.
-
Participate in group discussions, document analyses and cases
studies, allowing delegates to practice their interpersonal
communications skills, and to share ideas and experiences with their
peer group.
Course Assessment
This course has a formal assessment mechanism. To obtain the diploma,
delegates will need to complete the following assessments
-
Two written assignments (detailed evaluation of a technical document;
and submission of a project proposal)
-
A project comprising the development of an original technical
document
-
A written examination
-
Contributions and participation
To pass the Diploma, a final overall course mark of 50% as well as a
sub-minimum of 50% for the exam is required. Delegates obtaining a
final course aggregate of 75% or more will graduate with distinction.
Alternative assessments may apply to in-house courses.
Costs and Terms
The cost of this course is available on request. Discounts apply for
large numbers or in-house courses. Course fees cover tuition,
materials, notes and catering. All fees are payable in advance and
interest is levied on overdue accounts. Please refer to the standard
terms and conditions on the course confirmation form.
Course Venue
Public training is conducted at FTI’s premises in Cape Town and
Johannesburg. In addition, we rent temporary external venues in other
areas as we need them. Most in-house courses are held on company
premises and we will provide assistance regarding venue requirements to
ensure the quality of our course is not compromised.
Course Accreditation
Faculty Training Institute was an Approved Education & Training
Provider with the ISETT SETA, having received this approval in January
2003. FTI is currently in the process of applying for full
accreditation, which depends on the future structure of SAQA and the
National Qualifications Framework (NQF). FTI is also actively engaged
with various Standards Generating Bodies (SGBs) in ISETT to develop
standards and qualifications in selected areas.
This course falls into a category loosely defined by SAQA as
‘vocational short courses’ because it requires less than a year’s
full-time study and is not intended to lead to a national qualification
in terms of the NQF. Like many similar courses, it has therefore not
been registered as a formal qualification in SAQA. Nonetheless, this
course is widely recognized as a de facto qualification by industry
throughout South Africa.
Academically and intellectually, the course assessment is done at
senior undergraduate level, which would equate to level 5-6 on the NQF.
Course Content
Typical course content is outlined below.
Module 1, The Role of the Technical Writer, examines the roles and
responsibilities of technical writers within an organisational context.
Module 2,
Principles of Technical Writing, provides delegates with an
approach to writing that will be applied during the rest of the course.
Module 3,
Developing Technical Documentation, examines specific
requirements for common genres of technical writing.
Module 4,
Managing Technical Communications, exposes delegates to a
range of issues relating to the production and management of technical
writing in the workplace.
|
RLTW: The Role of the Technical Writer (1 day)
What is meant by technical communication. The need for effective
technical communication in industry and society. Roles and
responsibilities of technical writers. Knowledge, skills and personal
attributes of the successful technical writer.
PRTW: Principles of Technical Writing (3 days)
Identification of purpose; audience analysis; communication genres.
Document structure and content selection. Persuasion and argument. Some
practical approaches to writing.
Characteristics of good writing. Elements of style: formality, voice,
attitude, complexity, coherence. Logical development and transitions.
Layout and formatting. Editing for content, style and accuracy.
Identifying and avoiding common language errors.
Scoping and task analysis. Brainstorming, information gathering,
interviewing. Research tools. Project management techniques.
DVTD: Developing Technical Documentation (5 days)
Genres of technical writing : purpose and product. Typical document
structures, content and style.
Writing proposals : need, objectives, approach; findings, feasibility,
benefits, recommendation; timetable, budget, supporting data.
Procedural documentation : instructions and user manuals. Format,
version, updating; contents, key information, index; structure,
diagrams, cross referencing, terminology, completeness.
Technical reports and specifications. Purpose, summary, contents;
introduction, requirements, metrics, process ; results, conclusion;
references, appendices.
Online documentation. Purpose, audience, functions, updating;
structure, navigation, loading, scrolling, usability; content,
stickiness.
Technical correspondence. Emails, memos and letters. Newsletters, press
releases and articles for publication. Brochures, announcements and
advertisements.
MNTC: Managing Technical Communications (4 days)
The writing process : authoring tools, collaborative writing, dynamic
content, global language and cultural awareness, accessibility.
Document management : standards, versioning, templates and style
sheets, document management systems, translation.
Document production: editing, usability testing, distribution,
maintenance, quality management.
Business issues: copyright, privacy, ethics, referencing ; developing a
portfolio, employment, contracts, fees. Useful resources. Exam
preparation. |