Upload
neal-kaplan
View
123
Download
2
Embed Size (px)
Citation preview
WRITE THE DOCS NORTH AMERICA CONFERENCE 2016
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.
“DOCUMENTARIANS”?
• Technical writer: someone whose main job it is to create documentation
•Documentarian: everyone who really cares about documentation!
WHO ATTENDED
DAY -2: HIKE!
DAY -2: HIKE!
DAY -1: API DOC
SESSIONS
DAY -1: API DOC
SESSIONS
THERE I AM!
DAYS 1-2
ALSO ME!
IT WENT WELL!
ALL PRESENTATIONS WERE RECORDED
https://www.youtube.com/user/NextDayVideo/videos
WRITE THE READABLE README(DANIEL BECK)
JUST-IN-TIME DOCUMENTATION(BRIANNE HILLMER)
OOPS, I BECAME A PROGRAMMER(TARA SCHERNER DE LA FUENTE)
CODE THE DOCS: INTERACTIVE DOCUMENT ENVIRONMENTS
(TIM MCJONES & PARIS BUTTFIELD-ADDISON)
MOVE FAST AND DOCUMENT THINGS: WRITING INTERNAL DOCS AT FAST-MOVING ORGANIZATIONS
(RUTHIE BENDOR)
COPY THAT: HELPING YOUR USERS SUCCEED WITH EFFECTIVE PRODUCT COPY
(SARAH DAY)
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
MOST KEY POINT
“Docs are better when written with a team.”
SADLY, NO VOODOO
DOUGHNUTS FOR ME