15www.KLARITI.com

TechnicalWritingTips

1

How you doin’?

How you doing?

NOT buddy buddyConversational style

No jokes

2

we read user guides…

Stressed, lostWhen upset

As a last resort

Hi, I’m Ivan

www.Klariti.com

3

Who are writing for?

Give the big pictureBefore you start

Depth v Breath

4

The table of contents

Find info fasterMaster list of tasks

3 levels max

5

Task, Task, Task

Develop hubsUse task approach

Creating, Deleting, ing…

6

Flow naturally

In a sequenceOne idea to the next

Improve readability

7

Think Module

One idea, One topicUse chunks

Reuse elsewhere

8

Labels

Describe actionsUse effectively

Short, scannable

9

Screenshots

Procedure in actionDo they add value?

Crop and highlight

10

Illustrations

Tables, charts, diagramsBalance text to images

Explain content

11

Tables

Visual hierarchyCompare data

Interpret findings

12

Create an index

PhrasesWords

Concepts

13

Web

Write for webSome people hate PDFs

Link topics

14

Send for review(s)

Multiple reviewsStyle guide

Purge drafts

15

I think I found a

tpyo…

Test

QA against live systemDon’t test your docs

Expose errors

That help?

Got a question?Add your questions below the

video and we’ll get back to you

almost forgot...

Subscribe!thx

More at www.Klariti.com