Download as pptx, pdf, or txt
Download as pptx, pdf, or txt
You are on page 1of 17

Professionalism and Ethics in

Technical Writing
Ethics in writing means that you're honest with your
audience, you represent your evidence accurately by
avoiding exaggeration or disinformation, and you give
credit to the resources you use to complete your
writing.
Objectives

At the end of the lesson the students should be able


to:
1. Understand the Ethics and Law in Technical Writing.
2. Differentiate the Internal and External documents.
3. Apply the DO’s and DON’Ts in Technical Writing.
Relevant Laws and Ethical Considerations Related
to Technical Writing.

“In law, a man is guilty when he violates the rights of


others. In ethics, he is guilty if he only thinks of doing
so.” – immanuuel kant
Copyright Law

Covers the rights of the


author. In general, it is wrong
to use written material,
printed material, software, or
photographs without express
permission.

Ex: Books, Article, poems,


Music and Videos.
Trademark Law

Pertains to federal
protection (different from
registered trademark).
Ex: It is correct to specify
that you want a box
Kleenex® brand tissue
It is incorrect to ask for
kleenex
Contract Law

Covers written warranties or


their implied warranties. The
contract states the
agreements between the two
parties. That warranty may
be implied or express.
Liability Law

Pertains to
responsibilities or
obligation of writers
especially claims they
made on their paper.

Ex: professional
malpractice, defamation,
product defect and etc.
DO’s of Technical Communication

 Abide by relevant laws.


 Abide by the appropriate corporate or professional code of
conduct.
 Tell the truth.
 Be clear.
 Avoid discriminatory Language.
 Acknowledge assistance from others.
DON’Ts of Technical Communication

Falseimplications
Exaggerations
Euphemisms
Misleading the readers
Type of Documents

 Internal Documents Documents that  External Documents


are for internal organization, staff Documents that are public
members, or internal project team
facing are classified under the
members, like Development
Guidelines, Technical guide, external documents.
Testing Checklist, Manuals etc. 1. End User- Documents
2. Marketing Documents
Best Practices in Technical Writing

1. Know Your Audience


2. Plan your Document
3. Gain Technical Knowledge
4. Make it Interactive
5. Follow Grammar & Writing Rules
Know your Audience

Analyzing your Audience guides the intent of writing and determines


how complex or how simple the piece should be and how much the
content level should be.
• Identify your Target
• Know the Culture of your Audience
Plan your Documents

Plan the document skeleton


virtually in your mind while
you are collecting the
information. Create a list of all
the tiny actions you need to
take towards your goal

• Drafting
• Reviewing
• Revising
• Editing
Gain Technical Knowledge

A technical writer must understand the subject and


purpose of the document that are also relevant to the
document being written.
Make it Interactive

Technical writing is centered on good planning and audience


focus. Here are some tips to make your presentation interactive.
• Structured
• Typography
• Color code your notes
• Visuals
Follow Grammar and Writing Rules

Writing is somewhat delicate type of writing. You must put the words
in the write order so that people will understand what you are saying
or writing.
• Use active voice
• Be organized
• Be consistent
Take Away…

You might also like