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
![Page 1: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/1.jpg)
Confessions of a technical writer
![Page 2: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/2.jpg)
9.Nobody notices
what I do
Until I fail to do it
![Page 3: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/3.jpg)
8.A game of scrabble takes 4 days, 7 dictionaries, and a duel to the death.
![Page 4: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/4.jpg)
7.I hate help desk
(But they love me)
![Page 5: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/5.jpg)
6.I don t read manuals’
![Page 6: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/6.jpg)
UsersUsers
![Page 7: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/7.jpg)
ContributorsContributors
![Page 8: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/8.jpg)
DevelopersDevelopers
![Page 9: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/9.jpg)
5.Working with developers is hard
![Page 10: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/10.jpg)
4.I like waterfalls
![Page 11: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/11.jpg)
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
![Page 12: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/12.jpg)
3.Sometimes, things go
BANG!
![Page 13: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/13.jpg)
2.
I m special
’
But I m not ’
THAT special
![Page 14: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/14.jpg)
GetGetorganisedorganised
![Page 15: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/15.jpg)
ChooseChooseyouryourvoicevoice
![Page 16: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/16.jpg)
Say what you meanSay what you mean
![Page 17: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/17.jpg)
Use short sentencesUse short sentences
![Page 18: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/18.jpg)
Try not to be...
A pretentious jerkA pretentious jerk
![Page 19: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/19.jpg)
A word aboutA word about
passive voicepassive voice
(and cats)(and cats)
![Page 20: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/20.jpg)
Cut out the cruftCut out the cruft
![Page 21: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/21.jpg)
Read what you writeRead what you write
![Page 22: Confessions of a Technical Writer](https://reader033.vdocuments.site/reader033/viewer/2022051412/5482d47db47959000d8b4909/html5/thumbnails/22.jpg)
1.I will not stab you
Today.