Scribd
Upload
64 views67 pages

Technical Writing 101

This document is a transcript of a talk on technical writing skills. It discusses the writing process, where to get ideas, choosing simple and clear language, and tips for editing like keeping paragraphs short and rereading work from the perspective of the reader.

Uploaded by

oparikoko
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
64 views67 pages

Technical Writing 101

This document is a transcript of a talk on technical writing skills. It discusses the writing process, where to get ideas, choosing simple and clear language, and tips for editing like keeping paragraphs short and rereading work from the perspective of the reader.

Uploaded by

oparikoko
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 67

Elizabeth Naramore

Dutch PHP Conference


June, 2010
Technical Writing 101
1
ATTENTION.
2
THERE IS NO
CODE HERE.
3
THIS IS A
SOFT SKILLS
TALK.

THIS IS A
SOFT SKILLS
TALK.
!It"# n$t %&#t 'l&''( )&t *ill
+a,e -$& a #tr$nger(
+$re *ell.r$&n/e/ /e0el$1er.2
3
Help you with the writing proce
Help you impro!e your own writing
Point you to reference for the future
Thi# tal, *ill4
5
"log pot
#rticle
$echnical boo%
Documentation &en'(uer, 'e!)
Thi# tal, 1ertain# t$4
6
*oney
+ame
$o impro!e our own %nowle'ge
$o help other people
Wh- /$ *e *rite7
8
*oney &meh,)
+ame &meh,)
$o impro!e our own %nowle'ge
$o help other people
Wh- /$ *e *rite7
9
You are the $nl- $ne
that can #hare
*hat -$& ,n$*.
10
A l$t $' thi# $&t there.
!Let"# /e'late it.2
11
READ:7
12
An i/ea.
13
N$ i/ea#7
1
Problem you-!e ol!e' &how(to)
Where /$ *e get i/ea#7
13
Problem you-!e ol!e' &how(to)
People you-!e met &inter!iew)
Where /$ *e get i/ea#7
15
Problem you-!e ol!e' &how(to)
People you-!e met &inter!iew)
New thing you-!e trie' &opinion)
Where /$ *e get i/ea#7
16
Problem you-!e ol!e' &how(to)
People you-!e met &inter!iew)
New thing you-!e trie' &opinion)
.eearch you-!e 'one &new)
Where /$ *e get i/ea#7
18
1. ;RE.WRITE.
19
C$re/&+1.
20
<#e c&)ing.
21
Si/e 14 De#cri)e.
22
Si/e 24 C$+1are.
23
Si/e 34 A##$ciate.
2
Si/e 4 Anal-=e.
23
Si/e 34 A11l-.
25
Si/e 54 Arg&e.
26
S$rt an/ $&tline.
28
;l&g h$le# *ith re#earch.
29
2. WRITE.
30
3. EDIT.
!>a,e it n$t #&c,.2
31
Fir#t(
the ea#-.i#h #t&''.
32
Re#1ect the r&le#
$' the lang&age.
33
Chec, -$&r 'act#.
3
?I )elie0e +$re in the #ci##$r#
than I /$ in the 1encil.@
. Truman Capote
33
/$he 'ifference between the right wor'
an' the almot right wor' i the 'ifference
between lightning an' the lightning bug,0
- Mark Twain
Ch$$#e *$r/# *i#el-.
35
Si+1li'-.
36
$he pecimen of the canine pecie conume'
the e'ible ubtance belonging to him,
Si+1li'-.
38
$he pecimen of the canine pecie conume'
the e'ible ubtance belonging to him,
!eru
$he 'og ate hi foo',
Si+1li'-.
39
Kee1 1aragra1h# #+all
!)&t n$t t$$ #+all2.
1oo' etimate i
2(3 entence
0
Sec$n/(
the n$t #$ ea#-.i#h #t&''.
1
Clear l$gic. Clear *riting.
2
Kee1 the 'l$* g$ing.
3
D$n"t /il&te -$&r +e##age.

Empathy4 5'entification with an'


un'ertan'ing of
another- ituation, feeling, an' moti!e,
Thin, li,e -$&r rea/er.
3
Let"# /$
a chee#- eAerci#e.
5
6
8
9
En/ re#&lt4
Right7
30
I' -$& /$n"t tell +e(
I /$n"t ,n$*.
31
STO;.
!We"re n$t B&ite
/$ne -et.2
32
Rea/ it al$&/.
D$e# it 'l$*7
33
Elicit a #ec$n/
$1ini$n.
!S$+e thing#
$nl- seem li,e a
g$$/ i/ea.2
3
>$re #t&'' t$ re+e+)er.
33
Ca/ *riting i# ea#-.
Ca/ *riting +a,e#
rea/ing har/.
35
D$$/ *riting i# har/.
D$$/ *riting +a,e#
rea/ing ea#-.
36
;ractice +a,e# 1er'ect.
38
&Hopefully, it- omewhere between thee two,)
Fin/ -$&r $*n #t-le.
39
Why's (Poignant) Guide to Ruby
D$n"t l$#e the h&+an ele+ent.
50
Writing i# n$t a
c$nte#t $r a race.
51
You are the $nl- $ne
that can #hare
*hat -$& ,n$*.
52
RECA;
I/ea.
;re.*rite.
Write.
E/it E De.#&c,i'-.
Re1eat.
53
Thi# l$$,# 'a+iliar.
5
RECA;
S$'t*are ReB&ire+ent#.
;lanning E Te#ting.
C$/ing.
Re'act$ring.
Re1eat.
53
Nee/ re'erence# '$r later7
Ele+ent# $' St-le )- Str&n, E White
;$c,et C$$, $' Dra++ar '$r Engineer# an/
Scienti#t#
N:T >an&al $' St-le an/ <#age
>erria+ We)#ter"# ;&nct&ati$n an/ St-le
Dicti$nar- $' >i##1elle/ W$r/#
55
Want t$ c$ntact +e7
htt14FFnara+$re.netF)l$g
GEli=a)ethN
eli=a)ethGnara+$re.net
Freen$/e IRC4 Eli=a)ethN
THANKSH
#e0eral i+age# *ere &#e/ *ith 1er+i##i$n 'r$+4
. The a*e#$+e '$l,# at Chee=)&rger Net*$r, !htt14FFchee=)&rger.c$+F#ite#2
. >att Callar/ !htt14FFrealit-#i/e).c$+2

56

You might also like