Tweet
Tweet

Slide 1

Slide 1 text

Humanizing Your Documentation @carolstran

Slide 2

Slide 2 text

Why do we write documentation?

Slide 3

Slide 3 text

Use case driven documentation

Slide 4

Slide 4 text

bit.ly/tyner-blain

Slide 5

Slide 5 text

● How to adjust the speed ● How to change the direction of the drill ● How to change the drill bit bit.ly/tyner-blain

Slide 6

Slide 6 text

● How to drill a hole in a flat surface ● How to select the right screw for fastening items ● How to stir paint with your drill bit.ly/tyner-blain

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

Goal Use case bit.ly/tyner-blain

Slide 9

Slide 9 text

Goal Use case Functional Requirement Design Implementation bit.ly/tyner-blain

Slide 10

Slide 10 text

Goal Use case Functional Requirement Design Implementation bit.ly/tyner-blain

Slide 11

Slide 11 text

Goal Use case Functional Requirement Design Implementation bit.ly/tyner-blain

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

Language Gender neutral No “simple” or “easy” No read times Be literal Use plain language

Slide 14

Slide 14 text

Accessibility Well-structured content Descriptive linking Don’t use color to convey information Specific titles Watch your font weight