Uploaded by Ceciliapampii

Technical Writing Fundamentals

advertisement
Mount Carmel College
Technical
Writing
Fundamentals
Dr. Cecilia Osyanju
English Department
Hello Students!
Welcome to the Fundamentals of Technical Writing Class. In this session, we will be
exposed to
1) The core skills of technical writing
2) Know the types of technical documents and their structure
3)Know how to become technical writers
4)Resources for technical Writers
5) Tips for success in technical writing.
I want us to begin by defining technical writing.
Technical Writing Fundamentals
Page 1 of 6
What is technical writing?
It involves creating content that provides direction,
instruction, or explanation for a specific audience.
Technical writing is a form of writing that aims to document complex technical information
in a simple and accessible way.
It involves creating content that provides direction, instruction, or explanation for a
specific audience.
Technical writing can be in the form of long-form documents like user manuals or shortform content like emails.
The purpose of technical writing is to clearly and effectively explain something so that the
end user can easily understand and implement the information.
It focuses on creating digestible content with an intended purpose for a specific audience.
Technical documentation allows the end user to quickly reference and digest new
information, which helps companies enhance the user experience for their products and
services.
Technical Writing Fundamentals
Page 2 of 6
Role of Tecnical
Writers
They act as translators, ensuring that technical information is
accessible and understandable for the intended audience.
Their job is to bridge the gap between the technical expertise of
the staff and the knowledge and understanding of the end
users..
They work closely with subject matter experts and gather
information from them to create accurate and comprehensive
technical documentation.
Lets gain clarity on the role of technical writers
They act as translators, ensuring that technical information is accessible and
understandable for the intended audience.
Their job is to bridge the gap between the technical expertise of the staff and the
knowledge and understanding of the end users.
Technical writers often have to interface with multiple teams in order to understand the
project at a high enough level to be able to write about it.
They work closely with subject matter experts and gather information from them to create
accurate and comprehensive technical documentation.
In addition to writing, technical writers also engage in tasks such as researching, preparing,
and reviewing their work.
They strive to convey competency and subject matter expertise through their writing,
using a formal and neutral tone.
Their goal is to provide the end user with the information they need to effectively use a
product or implement a process.
Technical Writing Fundamentals
Page 3 of 6
Key Takeaway
Technical writing is the practice of documenting
complex technical information in a simple and
accessible way for a specific audience.
An example of technical writing is a user
manual that provides step-by-step
instructions on how to use a product.
💡 Key takeaway
Technical writing is the practice of documenting complex technical information in a simple
and accessible way for a specific audience.
An example of technical writing is a user manual that provides step-by-step instructions
on how to use a product.
Technical Writing Fundamentals
Page 4 of 6
🏃🏽‍♀️ Actionable
step
To improve your
technical writing skills,
practice breaking down
complex technical
concepts into simple
and understandable
language.
🏃🏽‍♀️ Actionable step
To improve your technical writing skills, practice breaking down complex technical
concepts into simple and understandable language.
Technical Writing Fundamentals
Page 5 of 6
❓
Quick Quiz
What is the purpose of
technical writing?
What is the role of
technical writers?
How can you improve
your technical writing
skills?
❓ Quiz
What is the purpose of technical writing?
- To document complex technical information in a simple and accessible way
What is the role of technical writers?
- To act as translators between technical staff and end users
How can you improve your technical writing skills?
- By practicing breaking down complex technical concepts into simple language
Great! Lets jump into the next session on Core Skills of Technical Writing.
Technical Writing Fundamentals
Page 6 of 6
Download