confessions of a technical writer
DESCRIPTION
We all know that technical writing is boring. That's why technical writers exist, so that developers don't have to write it. The bad news is that great technical documentation can do wonders for your project. The good news is you don't need to be a dyed-in-the-wool writer to create great technical documentation.Writing documentation for open source projects can be very different from writing for proprietary models. This discussion will cover why it is different, why it is important, and how you can fail to completely suck at it.TRANSCRIPT
Confessions of a technical writer
9.Nobody notices
what I do
Until I fail to do it
8.A game of scrabble takes 4 days, 7 dictionaries, and a duel to the death.
7.I hate help desk
(But they love me)
6.I don t read manuals’
UsersUsers
ContributorsContributors
DevelopersDevelopers
5.Working with developers is hard
4.I like waterfalls
Information Information Plan Plan (10%)(10%)
Content Content Specification Specification
(20%)(20%)
WritingWriting(50%)(50%)
TranslationTranslation&&
ProductionProduction(19%)(19%)
ReviewReview(1%)(1%)
`̀
ReleaseRelease
5 Phase Model by JoAnn Hackos5 Phase Model by JoAnn Hackos
3.Sometimes, things go
BANG!
2.
I m special
’
But I m not ’
THAT special
GetGetorganisedorganised
ChooseChooseyouryourvoicevoice
Say what you meanSay what you mean
Use short sentencesUse short sentences
Try not to be...
A pretentious jerkA pretentious jerk
A word aboutA word about
passive voicepassive voice
(and cats)(and cats)
Cut out the cruftCut out the cruft
Read what you writeRead what you write
1.I will not stab you
Today.
