Confessions of a Technical Writer

1,001 views

Published on

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.

Published in: Technology, Business
1 Comment
0 Likes
Statistics
Notes
  • Be the first to like this

No Downloads
Views
Total views
1,001
On SlideShare
0
From Embeds
0
Number of Embeds
7
Actions
Shares
0
Downloads
43
Comments
1
Likes
0
Embeds 0
No embeds

No notes for slide

Confessions of a Technical Writer

  1. 1. Confessions of atechnical writer
  2. 2. 9.Nobody notices what I do Until I fail to do it
  3. 3. 8.A game of scrabbletakes 4 days,7 dictionaries,and a duel tothe death.
  4. 4. 7. I hate help desk(But they love me)
  5. 5. 6.I don’t read manuals
  6. 6. Users
  7. 7. Contributors
  8. 8. Developers
  9. 9. 5. Working witdevelopers h i s h ar d
  10. 10. 4. waterf a l l sI like
  11. 11. Information Plan (10%) Content Specification (20%) Release Writing (50%) Translation Review & (1%) ` ` Production (19%) 5 Phase Model by JoAnn Hackos
  12. 12. 3.Sometimes, things go BANG!
  13. 13. 2. cial p e s tI’m o l n a ’ m ci I e ut sp B T H A T
  14. 14. Get organised
  15. 15. Choose your voice
  16. 16. Say what you mean
  17. 17. Use short sentences
  18. 18. Try not to be... A pretentious jerk
  19. 19. A word about passive voice (and cats)
  20. 20. Cut out the cruft
  21. 21. Read what you write
  22. 22. 1.I will not stab you Today.
  23. 23. My name is lanabrindley@gmail.comLanaBrindley. @LoquacitiesAnd I am atechnicalwriter. 0410 500 659

×