propelguru1 (11)

1
Introduction To Technical Writing
2
Technical Writing
Traditional Documentation
Technical Marketing Documentation
01
02
03
Science, Medical Papers, Research, and Reports

• Writing about technology, which is spread out in
  different fields like medicine, aerospace, and so
  on.

• Guides, Product Manuals, How-To Guides, and API
  Documentation

• White Papers, Case Studies, and B2B Proposals

3
RESEARCH
01

• Research is an essential step to follow before
  you start writing.
• You need to collect data and information that can
  add value to your blog. For that, you can use
  platforms like Google Scholar or other reliable
  sources.

4
UNDERSTAND
YOUR AUDIENCE
02

• Keep in mind for whom you are writing this blog.
  Say, for instance, you include technical jargon
  in your blog, the word might only be known to
  tech-savvy people only.
• So, write something that will be known to people
  of all ages and professions.

5
DON'T LOSE
FOCUS
03

• There are times when we keep on writing, and by
  the end of the blog, it has nothing to do with
  the subject matter. Don't do that.
• Understand what and for whom you are writing the
  blog and structure your content according to it.

6
PROVIDE TIMELESS INFORMATION
04

• Always remember that we are not writing a blog
  for today. It's staying on the site forever.
• So, make sure you add data and information that
  will help future readers as well. Your blog
  should be available and informative to the
  audience even after 30 years.

7
ATTRIBUTIONS WHENEVER
NECESSARY
05

• Attribution is basically giving backlinks to the
  content. This way they get to see some other
  article or blog related to a particular subject.
• Providing attribution or links in
• your blog will always help your
• Blog and the readers.

8
DON'T FOCUS ON WORD COUNT
06

• When it comes to technical writings, word counts
  don't matter. It will sometimes be 800 words,
  whereas sometimes, it will be just more than 300
  words.
• But remember, the smaller and more
  straightforward you can convey a thought,
• the better it is.

9
GRAPHICS TO
YOUR BLOG
07

• Graphics or tables or charts should adequately
  make the readers know what you want to convey.

10
KNOW ALL THE
DIGITAL TOOLS
08

• It is necessary to understand all the digital
  tools and understand how to use them. Technical
  writers are expected to create graphics and
  screen capture images.
• Not just that, you should also know how to
  extract valuable information from Excel sheets
  and convert them into data and charts.

11
SUBJECT OF TECHNICAL WRITING
ABSTRACT ITEMS
TANGIBLE ITEMS
SUBJECT
A computer or software program or on how to
assemble a pen
It includes something like steps required to
complete an office process.
12
API DOCUMENTATION

• API documents are a set of tutorials or
  references or guides that will help the other
  developers use its API.

13
Plan Before You Start

• While doing API documentation, it is essential to
  understand for whom you are preparing this API
  document. When you know the target audience, you
  will understand how to design and structure your
  blog and which language can be used.

14
Overview
01

• It is an essential part of an API document
  because you have to grab the reader's
• attention in this part. It is like a summary of
  what the API documentation is all about.

15
Resources
02

• It forms one of the main elements of API
  documentation. It is necessary to provide all the
  required information about your API doc in this
  section. All the parameters and details should be
  appropriately documented.

16
Error messages
03

• Provide your readers with information on the
  possible error messages they might receive. This
  way, you can learn and interact with your
  technology easily.

17
Authentication
04

• This only comes in handy if the API requires
  Authentication. This section is to explain how to
  get access credentials.

18
Avoid Jargons
05

• Try to maintain consistency throughout the blog.
  It should be uniform without any conflicting
  languages or codes.
• Use universally accepted terminologies
• to avoid any future confusion.

19
WHITE PAPERS

• White Papers are one of the challenging write-ups
  in Technical Documentation. They require a deep
  understanding of the subject matter in both the
  technical and application process for solving the
  problems. They are always written on templates.

20
Introduction
01

• It is to introduce the subject to the readers.
  They should get a perfect outline of the problems
  but do not share your solution with them yet.

21
Problem
02

• Tell the readers about the problem in a few
  paragraphs. Avoid using confusing language or
  what is called in White Paper language, "hidden
  assumptions."

22
Solve the Problem
03

• Unless and until you understand the problem, you
  won't be able to solve it. Tell the readers why
  your problem is the best solution. Convince them
  with examples or evidence.

23
Conclusion
04

• In a few paragraphs, tell the readers what the
  overall problem and your solution to it in-brief.

24
Thank You