Documentation Your Team Will Actually Use
Summary
Picture this: You spend weeks writing up your UX Playbook. Your Playbook covers every design and research method your team might use, when to use it, and how. It’s PERFECT. And... no one reads it. 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
"Our ability to entice participants to share their most personal stories raises the potential to exploit them for design research."
Rachael Dietkus, LCSWTrauma-Responsive Design: Reimagining the Future of Design Now
December 10, 2021
"Design systems haven't changed fundamentally; it’s just that AI removes the capacity to gloss over gaps with human judgment."
Robin CannonAI means your design system can't suck anymore
September 9, 2026
"In large complex systems, the dots are scattered across silos and time zones, making progress feel elusive."
Gina MendoliaTherapists, Coaches, and Grandmas: Techniques for Service Design in Complex Systems
December 3, 2024
"Using assistive technology is a skill and muscle memory built over years."
Sam ProulxUnderstanding Screen Readers on Mobile: How And Why to Learn from Native Users
October 2, 2023
"If you’re not in our Slack channel, you’re missing out on so many big parts of the party."
Bria AlexanderOpening Remarks
September 29, 2021
"Can we just hang out, get on the tube, and hang out at Heathrow? He looked at me very strangely."
Stephen PollardClosing Keynote: Getting giants to dance - what can we learn from designing large and complex public infrastructure?
November 7, 2017
"Multimodal design adds a layer of orchestration on top of modality-specific designs like voice or graphical UI."
Cheryl PlatzDemystifying Multimodal Design: The Design Practice You Didn't Know You're Doing
April 4, 2024
"Screen magnification is really about making the screen larger, changing color contrast, reducing motion, and panning around the magnified area."
Sam ProulxPrototype Reviews, People With Disabilities, and You
October 1, 2021
"If you extinguish 365 fires in a year, bravo, but what do you really have to show for it, and what’s next?"
Dominique WardThe Most Exciting Time for DesignOps is Now
September 8, 2022