Fundamentals of Technical Writing
||: 2 Day
Workshop Face-to-Face Instructor-led Workshop
upon request (Write to us at firstname.lastname@example.org)
(Karachi), Customer Onsite and Online
Comprehensive Student Guide and Workshop
workshop can also be conducted for customers in
Lahore, and Islamabad
A workshop designed
to develop leaders for tomorrow: Today, as companies
increasingly need to become more dynamic,
interconnected and flexible, thus certain soft
skills are becoming critical including technical
As per different
industry surveys, a requirement for maintaining a
single source of truth documentation is becoming an
essential requirement for all industry-wide
customers especially banking and FSI industry both
locally and internationally. Adopting standard
international writing styles and style guidelines
for writing technical contents such as maintaining a
library of application documentation, developing
SOPs, security policies, instruction and
administrations manuals, business cases, present and
upcoming digital transformation based projects and
all projects that you have closed successfully needs
to speak one common language, this is where this
workshop fits in.
would recommend all organizations to look into an
option to take this workshop as one of their new
2022 project and try to take all key stakeholders on
one page by inviting two-three people from each
Line-of-Business for this training course. We have
built this course to extend our professional writing
experience and would like to contribute in the space
where less than 5% of organizations in Pakistan are
looking at this point in time.
executives are now considering the acquisition of
technical writing skills as an essential components
important to fostering employee retention, improving
leadership capabilities and qualities, and building
a meaningful culture under an stressful challenging
environment. This workshop is designed to help
resources to improve there technical writing
skills with a vision to develop dynamic
leaders for tomorrow.
is unique because of its specialized content. It
must convey objectivity and reach both technical and
nontechnical audiences with exactness and clarity.
Along with writing emails, letters and reports, the
technical writer must be able to prepare
definitions, physical descriptions, product
specifications, procedures, test and laboratory
results, and many other kinds of documents.
Before taking this
two-day online course, the course participants are
expected to be familiar in performing following
THINKING IS CONSIDERED AS AN INTEGRAL ASPECT OF
Microsoft Word and Microsoft PowerPoint.
Microsoft Word as an editor for building documents
using features like how to build “Table of
Contents”, building tables and perform a basic
Microsoft PowerPoint and tools like Paint Brush
for building diagrams, workflows and saving them
in different graphic formats.
thinking is the analysis of facts to form a
judgment. The subject is complex, and several
different definitions exist, which generally include
the rational, skeptical, unbiased analysis, or
evaluation of factual evidence.
In this two-day technical writing
workshop, we typically begin with a critical
thinking exercise that asks participants to make
decisions based on a limited set of parameters;
essentially, they are to solve a problem using a
set of tools and they are to rationalize why they
made the decisions they did.
Since technical writing requires to
interact between different types of audience and
stakeholders therefore, the need for critical
At the end of this course, you will be
Among the Elements of Technical Documents
- Create a Full
Range of Technical Documents with a Solid
- Use Templates
to Jumpstart the Writing Process
Techniques for Overcoming Writer’s Block
Technical Data Based on the Writer’s Purpose and
the Reader’s Concerns
Detailed Messages with a Style for Technical and
- Structure the
Format to Enhance Presentation and Ideas
- Use Linking
Words and Phrases in Sentences and Paragraphs
- Apply Best
Practices for Displaying Visual Information
- Edit Language
for Precision, Clarity, and Conciseness
Language for Appropriateness
Complex Issues with Authority
- Delivering a
final project technical report as a part of a unit
- Employees in the workplace including
technology vendors, technology business
partners, customers from all business industries
and Line of Businesses including Business,
Application, Audit, Risk, Compliance, Security,
Network, IT operations, Project Management, and
- This workshop is also suitable for Pre
and Post Sales Technology Specialists, IT
Professionals, IT Consultants, Systems
Integrators, Systems & Solution Architects,
Sales and Marketing Specialists, Trainers,
Project Managers, Young Leaders and Managers,
individuals developing education and training
services material, and future Technical Writers.
- Authors, Documentation Managers,
Technical Writers, Change Managers, SOP writers
and validators, Forensic Investigators, and
Quality Assurance professionals.
- Project Managers, Enterprise
Architects, proposal writers and personals
writing for Quality Change Control.
Training will be
delivered by an experienced TOGAF 9 Certified
TOGAF EAF for over 12 plus years,
with 25+ years of career experience imparting
education and training services both locally and
internationally and have served international
enterprise technology vendors including IBM,
Fujitsu, and ICL.
instructor holds various industry professional
certifications in the space of enterprise servers
and storage technologies, Information Security,
Enterprise Architecture, Blockchain, ITIL, Cloud,
Virtualization, Green IT, and a co-author of 10
IBM Redbooks and have designed and developed 70
plus courses based on storage, information
security, cybersecurity, enterprise architecture,
Blockchain, Open Banking Framework and digital
course flow will be a mix of lectures &
interactive classroom discussions, video
demonstrations, short exercises and assessments so
that participants can have a detailed understanding
of various components of technical writing. The last
unit of this workshop includes an assignment for
individuals and teams for writing a technical
|Unit 1: Critical
Thinking - An Integral Aspect of Technical
20 minute ACTIVITY based on measuring
STRESS level of employees during
general Thinking Process.
is Critical Thinking?
the Critical Thinking Process.
6 Critical Thinking Standards.
8 elements of Critical Thinking.
is Critical Thinking Developed?
Thinking in Everyday Life.
Thinking Skills is a prerequisite to
five Critical Thinking skills.
Solving and Critical Analysis Skills –
Possible Questions and Answers.
can I assess my Critical Thinking
can I improve my Critical Thinking
to avoid most common pitfall in Critical
10 Skills – In Times to Come.
Thinking – Fact or Opinion.
Unit 2: Technical
generalized five steps writing process.
Writer Job Description is
a team for writing the technology
the Chapter contents and Chapter titles.
the title of the book/project.
Writer – Tasks, Background, and Skills.
Formatting and Language is important?
purpose of Technical Writing.
components of effective technical
features for making your technical
writing more competent.
that Use Technical Writing.
Technical Writing Process.
Elements of a Successful technical
Documentation by Stages and Purpose – A
the Agile and Waterfall Technical
Documentation Types – A bigger picture.
Writing Leadership Qualification.
to Manage a Technical Writing Team.
key attributes of Technical Writing.
most common Technical Writing mistakes.
five Technical Writing Tools.
Guidelines for Technical Writing –
Objectives and Methods.
Technical Writer Style Guide.
are the Steps for Writing your own Style
|Unit 3: Guidelines for
Writing a Technical Volume
between analytics & business
work and general practices that should
a Technical Writing Framework.
Technical Writing Mistakes.
Title Front Page of your Volume – Layout
layout of your Second and Third Page of
Fourth Page – Setting up your first
Edition Information details.
of Contents and Appendices.
Preface Page of your Title Volume.
1 – Example with details.
a Note or Warning Indicator signs.
Tables in your documents.
use of Round-Square box command syntax
and System Menus.
the diagrams and using drawing tools –
IBM AIX SMIT Menu Example.
Sources required to write your Title
of IT Technical Change Management in
Technical Change Management – Roles and
Responsibilities, and Change Management
to Create a Change Management Plan for
Based Unit Exercise.
Unit 4: Writing an
Email Migration Services Technical
Detailed Introduction – Final Group
your organization have been selected as
a key Services Providers for this
client services Scope of Work (SOW) –
Functional and Non-Functional Services
1 – New hardware platform sizing
guidelines running clients email
2 – Software platform selection for an
3 – Professional IT Services to
implement seamless migration to the new
is expected from you as a part of this
a Technology Proposal to Client in
Presentation to Client.
requirements & traditional
Storage Sizing Guidelines – An Example.
prior investing in new technology
solution – An Example from Sizing
recommended Patch Management Best
Practices SOPs Example.