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
"We encourage one-to-one video calls to build rapport and feel comfortable reaching out for advice."
Marc Fonteijn Ru ButlerIncrease your confidence, influence, and impact (through a Professional Community)
December 3, 2024
"Asking stupid questions can lead experts to reframe their thinking and improve the work."
Dem Gerolemou Alexis Oh Neef RehmanClimate technology fundamentals
May 15, 2024
"Our benchmarking survey includes free exploration of the entire website or app, not just the homepage."
Daniela Magaña Flores Ariane Rahn Jeff Ephraim BanderAhead of Competition: Learn What UX Benchmarking Can Do for Your Business Today
March 10, 2022
"I got a no. The message I was hearing was, scale the best you can with what you have and make it work."
Abbey Smalley Sylas SouzaScaling UX Past the Size of Your Team
January 8, 2024
"We never documented our criteria, leaving stakeholders feeling our decisions were mysterious."
Patrick CommarfordDesign Staffing for Impact
January 8, 2024
"You either give money as an unprofessional civilian or you do your job and offer professional services to help the crisis."
Xenia Adjoubei Sean BruceEmpowering Communities Through the Researcher in Residence Program
March 29, 2023
"Stop being the unquestioning executors of a marketing plan based on 20th century logic and values."
Craig VillamorDesign Systems for Ethical Design
January 26, 2023
"Fostering a culture of use and leadership is essential to make these tools part of daily rituals."
Jon Fukuda Ellie KryslDesign Planning and Management Support
October 3, 2023
"Our hypothesis was we could create better product faster with more eyes looking at the problem, not just product."
Iain McMaster IHan ChengDesign and Product: from Frenemy to Harmony
November 29, 2023