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
"Empathy applies to us too—we needed to understand how our own people were feeling about these layered changes."
Erin HauberDesign is Not the Frosting on the Scaled Agile Layer Cake
October 24, 2019
"You aren’t going to turn into an arrogant jerk by believing in yourself more."
Megan KiersteadYou Are a Badass at UX: Overcoming Imposter Syndrome
March 10, 2021
"The power to say no has been a blessing in disguise, helping us refocus on high priority work after layoffs."
Maggie DieringerCreating Consistency Through Constant Change
January 8, 2024
"Lift and shift equals timidity—it’s sticking to what you know rather than delivering real value."
Meaghan Waters Fotina KoutropoulousLack of Product Thinking will Doom Your Legacy Modernization
June 9, 2021
"Brand is not just what you say, it’s what you do — your product and design live and breathe the brand."
Jemma AhmedBringing together market and user research
October 17, 2019
"Knowledge management solutions must focus on both the explicit knowledge that can be documented and the tacit knowledge that resides in people’s experiences."
Maria TaylorKnowledge is Power: Managing the Lifeblood of the Design Org
October 3, 2023
"Auto-complete absolutely is an accessibility feature because it helps reduce typing effort for screen reader users."
Sam ProulxUnderstanding Screen Readers on Mobile: How And Why to Learn from Native Users
June 6, 2023
"Some managers felt undermined because they were part of the delivery team rather than just overseeing it."
Catherine BlizzardUsing Integrated Insight to Drive Growth
March 10, 2022
"Do I find a way to make this conversation more about the software as scheduled or do I show Laura how to react to the unplanned?"
Randolph Duke IIWar Stories LIVE! Randy Duke II
March 30, 2020