Technical Writing for hoopy open source froods who really know  where their towels are
Me
What is this documentation stuff anyway?
Why Document?
Who Does?
Users
Contributors
Developers
So ... What's in it  for me?
 
Information Plan Content Specification Writing Translation & Production Review Release 5 Phase Model by JoAnn Hackos
Planning 10%
Content Specification (Isn't there some rule about cats in presentations?) 20%
Writing 50%
Translation 19% i18n L10n g11n
Review 1%
Maintenance
What happens when things ... GO WRNOG?
 
You  need tools!
Get organised
Choose your voice
Say what you mean
Use short sentences
Don't be A pretentious jerk
A word about passive voice (and cats)
Cut out the cruft
Where there’s a  will  ... There’s a way to rewrite it
Read what you write
 
+61 410 500 659 [email_address] @Loquacities Lana Brindley
Upcoming SlideShare
Loading in …5
×

Technical Writing for Hoopy Open Source Froods Who Really Know Where Their Towels Are

983 views

Published on

Documentation for open source projects can sometimes be daunting, but is always rewarding. This lecture describes the method for tackling an open source writing project, and provides information and tools on getting the job done in the easiest and best way possible.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
983
On SlideShare
0
From Embeds
0
Number of Embeds
3
Actions
Shares
0
Downloads
11
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Technical Writing for Hoopy Open Source Froods Who Really Know Where Their Towels Are

  1. 1. Technical Writing for hoopy open source froods who really know where their towels are
  2. 2. Me
  3. 3. What is this documentation stuff anyway?
  4. 4. Why Document?
  5. 5. Who Does?
  6. 6. Users
  7. 7. Contributors
  8. 8. Developers
  9. 9. So ... What's in it for me?
  10. 11. Information Plan Content Specification Writing Translation & Production Review Release 5 Phase Model by JoAnn Hackos
  11. 12. Planning 10%
  12. 13. Content Specification (Isn't there some rule about cats in presentations?) 20%
  13. 14. Writing 50%
  14. 15. Translation 19% i18n L10n g11n
  15. 16. Review 1%
  16. 17. Maintenance
  17. 18. What happens when things ... GO WRNOG?
  18. 20. You need tools!
  19. 21. Get organised
  20. 22. Choose your voice
  21. 23. Say what you mean
  22. 24. Use short sentences
  23. 25. Don't be A pretentious jerk
  24. 26. A word about passive voice (and cats)
  25. 27. Cut out the cruft
  26. 28. Where there’s a will ... There’s a way to rewrite it
  27. 29. Read what you write
  28. 31. +61 410 500 659 [email_address] @Loquacities Lana Brindley

×