Open Source Documentation Panel - Contributing.today

 

I joined a panel at Contributing Today talking about open source documentation with:

• Scott Riley, product designer Gitbook, author of Mindful Design
• Lorna Mitchell, developer advocate Aiven, maintainer rst2pdf
• Jen Weber, web developer and writer at Ember.js

Some of the topics we covered:

• What are good docs and exemplars?
• Should different specializations be used for different doc types?
• Where to start learning about being a tech writer?
• How to improve docs for your project?
• Making your open source project attractive for tech writers to join.
• Accessibility.
• Doc strategy, information architecture, processes.
• Gitbook, The Good Docs Project, Season of Docs, rst2pdf.