8/11/2019 technicalwriting2.

1/11

TECHNICAL WRITING

INTRODUCTION

8/11/2019 technicalwriting2.

2/11

CONTENTS

Purpose of course

Technical writing characteristics

Technical writing

Course requirements

8/11/2019 technicalwriting2.

3/11

DEFINITION/PURPOSE OF

COURSE

Technical communication is the art and science of making

complex technical information accessible, usable, and relevantto a variety of audiences in a variety of settings.

Composition of the types of documents technical

professionals write

Review of the planning, drafting, and editing processes

Interaction with new technologies and new environments

8/11/2019 technicalwriting2.

4/11

ACCESSIBILITY

Accuracyno errors of fact or grammar

Clarityno ambiguityCompletenessall necessary information is present

Dictionappropriate and grammatically correct language

Organizationlogical arrangement of parts

Visual effectivenesspage/screen design, graphics

8/11/2019 technicalwriting2.

5/11

USABILITY

Allows audience to perform the task or retrieve the information

they need

Studies design of table of contents, index, headings, etc.

Keeps learning curve short

8/11/2019 technicalwriting2.

6/11

RELEVANCE

Focus on your audiences need for information.

Give only whats needed.

Use language that fits your audience and situation and is

consistent.

8/11/2019 technicalwriting2.

7/11

ON-THE-JOB WRITING Communicate expertise to clients, customers, and the public Report tech activities to supervisors and others

Write proposals

Instruct lay people

Correspond with colleagues and clients

8/11/2019 technicalwriting2.

8/11

TECH COMMUNICATORS

SKILLS

Facility with language

Use of critical thinking skills to solve problems

Ability to assess situations, determine what the most important

issues and the subsidiary ones are

Ability to organize a document that presents the information

clearly

8/11/2019 technicalwriting2.

9/11

8/11/2019 technicalwriting2.

10/11

Application, follow-up letters,

and rsums

Technical Definition

Proposal

Collaborative process manual

and oral presentation

Product/service comparison

WRITING ASSIGNMENTS

Formal report

Progress Report

Personal and professional

website

Class notes

Report outline in PowerPoint.

8/11/2019 technicalwriting2.

11/11

HOME PAGE CREATION

Create or update your web site.

Put the pages together manually first

Use an editor or continue to work manually once youre working

on your own.

Link to a web site you already have, adding the requirements for

this new part of your site.