Write the Docs 2016 NA conference summary
Download as PPTX, PDF1 like194 views
This document summarizes the Write the Docs North America conference in 2016. It provides details on who attended the conference, including technical writers, developers, marketers and others interested in documentation. It lists some of the session topics, which focused on writing readable documentation, just-in-time documentation approaches, and techniques for documenting internal products and APIs. A key takeaway was that documentation is best when created through collaboration between writers and other teams.
Write the Docs 2016 NA conference summary
- 1. WRITE THE DOCS NORTH AMERICA CONFERENCE 2016
- 2. HTTP://WWW.WRITETHEDOCS.ORG/ We consider everyone who cares about communication, documentation, and their users to be a member of our community. This can be programmers, tech writers, customer support, marketers, and anyone else who wants people to have great experiences with software.
- 3. “DOCUMENTARIANS”? • Technical writer: someone whose main job it is to create documentation • Documentarian: everyone who really cares about documentation!
- 4. WHO ATTENDED
- 9. THERE I AM!
- 10. DAYS 1- 2
- 11. ALSO ME!
- 12. IT WENT WELL!
- 13. ALL PRESENTATIONS WERE RECORDED https://www.youtube.com/user/NextDayVideo/videos
- 14. WRITE THE READABLE README (DANIEL BECK)
- 16. OOPS, I BECAME A PROGRAMMER (TARA SCHERNER DE LA FUENTE)
- 17. CODE THE DOCS: INTERACTIVE DOCUMENT ENVIRONMENTS (TIM MCJONES & PARIS BUTTFIELD-ADDISON)
- 18. MOVE FAST AND DOCUMENT THINGS: WRITING INTERNAL DOCS AT FAST-MOVING ORGANIZATIONS (RUTHIE BENDOR)
- 19. COPY THAT: HELPING YOUR USERS SUCCEED WITH EFFECTIVE PRODUCT COPY (SARAH DAY)
- 20. KEY POINTS • Document what the user is doing, not what the app is doing • Just-in-Time vs. Just-in-Case documentation • Good internal communication is rare, valuable, and results in better docs
- 21. MOST KEY POINT “Docs are better when written with a team.”
Editor's Notes
- #12: My presentation was about docs and support, but it could have been “Bridging the game between documentation and <fill in the team>”
- #18: They talked about some of the different interactive document environments out there – mainly IPython Notebooks and Swift Playgrounds – and the strengths and weaknessesof these tools. They also talked about where these tools are going, as well as the implications for technical documentation.