Documentation Your Team Will Actually Use
Summary
I’ve been there! I’ve led or contributed to 4 Playbooks, 2 toolkits and uncountable miscellaneous “how to” docs in my 8 years as a UX Designer and Operations Manager. In this talk, we’ll cover how to: avoid common pitfalls in documentation, discover what your team needs most, apply a design process to your documentation efforts and deliver incremental value through documentation your team will actually use.
Key Insights
-
•
There are two primary types of documentation: process and policy documents, typically made by managers or design ops, and project records created by individual contributors.
-
•
Playbooks streamline organizational design practices by organizing actionable content into stages and plays reflecting the team's mental model.
-
•
Common pitfalls in documentation include unactionable generic information, difficult navigation, cognitive overload from excessive detail, and outdated content that erodes trust.
-
•
Teams overwhelmingly rely on numerous tools (13 on average in UX research), making accessible and clear playbooks essential especially for new hires and junior designers.
-
•
Applying a design thinking process to documentation—empathize, prioritize, prototype small sections, test, and circulate—helps create valuable, user-friendly resources.
-
•
Empathizing means understanding how your team currently accesses information, avoiding top-down imposed processes, and discovering real pain points through interviews, surveys, and desk research.
-
•
Delivering incremental, usable sections instead of waiting to complete the entire playbook increases adoption and feedback opportunities.
-
•
Shared ownership of playbook sections by contributors encourages more frequent referencing and greater relevance.
-
•
Tools like Coda offer useful analytics such as page views and video engagement metrics that help track documentation adoption and identify pain points.
-
•
Regular review and content updating, ideally on a quarterly or semiannual cadence, is critical to maintain trust and ensure documentation relevance.
Notable Quotes
"Our folks are not looking for information about what are wireframes. They want information specific to your organization."
"If folks can't find the information, it doesn't matter how well it is written."
"Avoid walls of text and create visual hierarchy to ensure scanability by using headers, sections, lists, and images."
"Outdated content will erode trust and make folks question whether other information is worth their time."
"You should not try to deliver your playbook from the ivory tower of design ops. It just will not be successful."
"Start with the biggest pain points your team is experiencing and find the biggest potential impact."
"You don't want to hide away for six months and try to build the perfect documentation. It won't work."
"Encourage adoption by sharing documentation in relevant channels, referring team members to it, and including it in onboarding."
"I love getting other people in there. Shared ownership means people are going to reference it more often."
"Use whatever information is available in the tool. Views, downloads, and links in Slack channels are all helpful adoption metrics."
Or choose a question:
More Videos
"An elite athlete doesn’t turn up at the Olympics and do their thing without coaches, physios, nutritionists."
Dr. Karl JeffriesThe Science of Creativity for DesignOps
January 8, 2024
"Making your chief legal officer your best friend as a designer makes a lot of sense."
Amy MarquezINVEST: Discussion
June 15, 2018
"The weakest insight method might win simply because of the relationship to the power structure."
Steve Portigal Chris Chapo Kelly Goto Christian RohrerDiscussion
May 13, 2015
"We covered critical design gaps without waiting for headcount allocation or hiring delays."
Alicia MootyDesign Staffing Models
September 30, 2021
"UX should be a critical dependency, not an afterthought or checkbox on the to-do list."
Ana Maria Montero Barrantes Aditi Dhar Michelle Kaplan Nate Osborne Matt LaurenceThe Authentic UX Talent Show
January 8, 2024
"You can’t really advocate for UX or move an organization forward without interacting with your team and business colleagues."
Lada Gorlenko Sharbani Dhar Sébastien Malo Rob Mitzel Ivana Ng Michal Anne RogondinoTheme 1: Discussion
January 8, 2024
"Data entry is the enemy; automation is the key to making research repositories successful."
Sofia QuinteroThe Product Philosophy Behind EnjoyHQ
March 10, 2021
"Nobody loves it when someone from another department shows up to tell people how to do their jobs better."
Laura KleinUnique challenges of innovation in enterprises
April 23, 2020
"Without Jim, what we're going to see today would have been a lot worse."
Andrew MichaelBuilding a Product Insights Team
March 10, 2022