Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Who Writes the Docs?

In the wider tech writer world, it’s still common to hear tech writers be certain that developers can’t write good help: the prevailing sense is “Only we can do this.” But those same tech writers often feel under threat in their jobs - feeling like their organisation doesn’t see their value, doesn’t understand what they do.

Who should write the docs? Should all developers write docs as a matter of course? Is it even worthwhile having specialist writers?

In this talk I’ll try to find some answers to these questions, based on my experience working in many teams - both in teams that have valued tech writing and in teams that haven’t. I’ll talk about the ‘documentarian’ mindset and how that contributes to better software, no matter what your job title is.

I’ll also explore the benefits that come from specialist writers and generalist developers working together. And I’ll share the ways I’ve found that people with specialist writer skills (whether they’re developers, tech writers, or other roles) can make the biggest difference to user experience, and through that to their organisations.

  • Login to see the comments

  • Be the first to like this

Who Writes the Docs?

  1. 1. Who Writes the Docs? Beth Aitman | @baitman lead tech writer at improbable.io
  2. 2. This is a talk about documentation culture @baitman
  3. 3. This is a talk about documentation culture @baitman
  4. 4. Who writes the docs depends on... @baitman - What is valued. - What skills you need.
  5. 5. @baitman Who writes the docs depends on... - What is valued. Questioning the value: - Do we need really need it? - How hard can it be? - What skills you need.
  6. 6. @baitman Who writes the docs depends on... - What skills you need. Questioning the skills: - Do you need to be a specialist writer? - What is valued. Questioning the value: - Do we need really need it? - How hard can it be?
  7. 7. To write well for users, you need... @baitman - ability to communicate decently - product knowledge - knowledge about users
  8. 8. “Developers can’t write” is a myth @baitman
  9. 9. “Developers can’t write” is a myth @baitman
  10. 10. “Developers can’t write” is a myth @baitman
  11. 11. Reacting defensively @baitman
  12. 12. Reacting defensively @baitman
  13. 13. Opening up @baitman
  14. 14. Opening up @baitman
  15. 15. How to get people involved @baitman
  16. 16. How to get people involved @baitman - ideology of what their job is - using the documentarian mindset
  17. 17. How to get people involved @baitman - ideology of what their job is - using the documentarian mindset
  18. 18. The documentarian mindset @baitman
  19. 19. The documentarian mindset - empathy for users and for learners - explain in a way users can understand - use any tool (not just docs) blog.thoward37.me/articles/developer-to-documentarian @baitman
  20. 20. The documentarian mindset - empathy for users and for learners - explain in a way users can understand - use any tool (not just docs) blog.thoward37.me/articles/developer-to-documentarian @baitman
  21. 21. @baitman
  22. 22. @baitman
  23. 23. @baitman
  24. 24. @baitman
  25. 25. Spreading the documentarian mindset @baitman
  26. 26. Spreading the documentarian mindset @baitman
  27. 27. Spreading the documentarian mindset @baitman
  28. 28. The role of specialists @baitman
  29. 29. The role of specialists @baitman
  30. 30. The role of specialists @baitman
  31. 31. Thanks for listening! @baitman

×