10 common edits

in technical writing

Who dis?

Chris Sevilleja

@chrisoncode

scotch.io

Why

who

code scraper

weekend Warrior

Bootcamper

dip toes in waterer

👉

put them in your

living room

Build trust

Typose

1

S

Q

M

T

webpack

Webpack

😕

Tie-pos

2

use Grammarly

or antidote

tipohs

3

use links

🖇

why???

4

Looong Intro

5

quicktro

No Fluff Please

6

Code

Block

Etiquette

7

Code

Blockiquette

I vs We

8

skimmability

9-10

3 paragraphs together

images

bullet points

headings

code blocks

🚫

people read upwards

👆

people want code

💎

time

trust

give me the code

tell me why

get to the point

give me demo

👉

k. thx. bai.

Chris Sevilleja

@chrisoncode

scotch.io

10 Common Technical Writing Edits

By Chris Sevilleja

10 Common Technical Writing Edits

  • 228
Loading comments...

More from Chris Sevilleja