Course
Duration |
: Key
Fundamentals of Technical Writing |
Course
Duration |
: 2 Day
Workshop Face-to-Face Instructor-led Workshop
- Classroom
|
Course Fee |
: Available
upon request (Write to us at info@tlcpak.com) |
Course
Location |
: TLC
(Karachi), Customer Onsite and Online |
Course Code |
: TN216 |
Deliverables |
:
Comprehensive Student Guide and Workshop
Certificate |
Customer onsite
workshop can also be conducted for customers in
Lahore, and Islamabad
ABOUT THIS
WORKSHOP:
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
writing.
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.
Therefore, we
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.
Moreover, senior
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.
COURSE
HIGHLIGHTS:
Technical writing
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.
WORKSHOP
PREREQUISITES:
Before taking this
two-day online course, the course participants are
expected to be familiar in performing following
tasks.
- Using
Microsoft Word and Microsoft PowerPoint.
- Using
Microsoft Word as an editor for building documents
using features like how to build “Table of
Contents”, building tables and perform a basic
document formatting.
- Using
Microsoft PowerPoint and tools like Paint Brush
for building diagrams, workflows and saving them
in different graphic formats.
WHY CRITICAL
THINKING IS CONSIDERED AS AN INTEGRAL ASPECT OF
TECHNICAL WRITING?
Critical
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
thinking evolved.
WORKSHOP
OBJECTIVES:
At the end of this course, you will be
able to:
- Distinguish
Among the Elements of Technical Documents
- Create a Full
Range of Technical Documents with a Solid
Structure
- Use Templates
to Jumpstart the Writing Process
- Use
Techniques for Overcoming Writer’s Block
- Evaluate
Technical Data Based on the Writer’s Purpose and
the Reader’s Concerns
- Prepare
Detailed Messages with a Style for Technical and
Nontechnical Writers
- 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
- Choose
Language for Appropriateness
- Summarize
Complex Issues with Authority
- Delivering a
final project technical report as a part of a unit
assessment.
TARGET
AUDIENCE:
- 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
Legal professionals.
- 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.
ABOUT THE
INSTRUCTOR
Training will be
delivered by an experienced TOGAF 9 Certified
trainer, practicing
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.
Our
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
technologies stacks.
The training
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
proposal.
COURSE
OUTLINE
Unit 1: Critical
Thinking - An Integral Aspect of Technical
Writing
- A
20 minute ACTIVITY based on measuring
STRESS level of employees during
Pandemic.
- Critical
Thinking Assessment.
- A
general Thinking Process.
- What
is Critical Thinking?
- Knowing
the Critical Thinking Process.
- Understand
6 Critical Thinking Standards.
- Describing
8 elements of Critical Thinking.
- How
is Critical Thinking Developed?
- Critical
Thinking in Everyday Life.
- Why
Thinking Skills is a prerequisite to
Critical Thinking.
- Top
five Critical Thinking skills.
- Problem
Solving and Critical Analysis Skills –
Possible Questions and Answers.
- How
can I assess my Critical Thinking
skills?
- How
can I improve my Critical Thinking
skills?
- How
to avoid most common pitfall in Critical
Thinking?
- Top
10 Skills – In Times to Come.
- Critical
Thinking – Fact or Opinion.
- Unit
1 Assessment.
Unit 2: Technical
Writing Fundamentals
- Technical
Writing defined.
- A
generalized five steps writing process.
- Technical
Writer Job Description is
Evolving.
- Building
a team for writing the technology
paper/book.
- Choosing
the Chapter contents and Chapter titles.
- Selecting
the title of the book/project.
- Technical
Writer – Tasks, Background, and Skills.
- Why
Formatting and Language is important?
- Primary
purpose of Technical Writing.
- Key
components of effective technical
writing.
- Additional
features for making your technical
writing more competent.
- Documents
that Use Technical Writing.
- The
Technical Writing Process.
- Key
Elements of a Successful technical
Writing Methodology.
- Project
Documentation by Stages and Purpose – A
High-level Sample.
- Describing
the Agile and Waterfall Technical
Writing approaches.
- Possible
Documentation Types – A bigger picture.
- Technical
Writing Leadership Qualification.
- How
to Manage a Technical Writing Team.
- 10
key attributes of Technical Writing.
- The
most common Technical Writing mistakes.
- Top
five Technical Writing Tools.
- General
Guidelines for Technical Writing –
Objectives and Methods.
- Describing
Technical Writer Style Guide.
- What
are the Steps for Writing your own Style
Guide?
- Unit
2 Assessment.
|
Unit 3: Guidelines for
Writing a Technical Volume
- Differentiating
between analytics & business
analytics.
- Research
work and general practices that should
be avoided.
- Building
a Technical Writing Framework.
- Avoid
Technical Writing Mistakes.
- The
Title Front Page of your Volume – Layout
and Design
- The
layout of your Second and Third Page of
your Volume.
- The
Fourth Page – Setting up your first
Edition Information details.
- Table
of Contents and Appendices.
- The
Preface Page of your Title Volume.
- Comments
Page Layout.
- Chapter
1 – Example with details.
- Specifying
a Note or Warning Indicator signs.
- Specifying
Tables in your documents.
- The
use of Round-Square box command syntax
and System Menus.
- Creating
the diagrams and using drawing tools –
IBM AIX SMIT Menu Example.
- Appendix
Qualification Criteria.
- Information
Sources required to write your Title
Volume.
- Importance
of IT Technical Change Management in
Technical Writing.
- IT
Technical Change Management – Roles and
Responsibilities, and Change Management
Plan.
- How
to Create a Change Management Plan for
Smooth Transition?
- Task
Based Unit Exercise.
- Unit
3 Assessment.
Unit 4: Writing an
Email Migration Services Technical
Proposal
- Unit
Detailed Introduction – Final Group
Activity.
- Why
your organization have been selected as
a key Services Providers for this
project?
- Assessing
client services Scope of Work (SOW) –
Functional and Non-Functional Services
Components.
- Part
1 – New hardware platform sizing
guidelines running clients email
application.
- Part
2 – Software platform selection for an
email application.
- Part
3 – Professional IT Services to
implement seamless migration to the new
platform.
- What
is expected from you as a part of this
course?
- Submit
a Technology Proposal to Client in
Two-weeks timeframe.
- Vendors
Presentation to Client.
- Business
requirements & traditional
Technology Limitations.
- Recommended
Storage Sizing Guidelines – An Example.
- Consideration
prior investing in new technology
solution – An Example from Sizing
Point-of-View.
- Writing
recommended Patch Management Best
Practices SOPs Example.
- Unit
4 Assessment.
|
|