Rosenverse
Documentation Your Team Will Actually Use

This video is only accessible to Gold members. Log in or register for a free Gold Trial Account to watch.

Log in Register

Most conference talks are accessible to Gold members, while community videos are generally available to all logged-in members.

Documentation Your Team Will Actually Use

Gold
Tuesday, October 3, 2023 • DesignOps Summit 2023
Share the love for this talk
Documentation Your Team Will Actually Use
Speakers: Gabrielle Verderber
Link:

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."

Ask the Rosenbot
George Abraham
Design Systems To-Go: Reimagining Developer Handoff, and Introducing App Builder (Part 2)
2021 • DesignOps Summit 2021
Gold
Lada Gorlenko
Theme 3: Introduction
2021 • Design at Scale 2021
Gold
Chris Engledowl
A Mixed Method Approach to Validity to Help Build Trust
2023 • QuantQual Interest Group
Courtney Maya George
Scale Your Organization and Grow Your Designers
2022 • DesignOps Summit 2022
Gold
Ren Pope
Building Experiences for Knowledge Systems
2023 • Enterprise UX 2023
Gold
Sarah Fathallah
A Typology of Participation in Participatory Research
2023 • Advancing Research 2023
Gold
Andy Polaine
What is the role of service design in product-led organizations?
2024 • Advancing Service Design 2024
Gold
Kat Vellos
Opener: The Other L Word
2024 • DesignOps Summit 2020
Gold
Maria Skaaden
Panel Discussion: Methodologies and Work Environments
2018 • DesignOps Summit 2018
Gold
Alicia Mooty
Design Staffing Models
2021 • DesignOps Summit 2021
Gold
Ryan Rumsey
Business Influence Without Losing Your Soul
2021 • Enterprise Community
Wendy Johansson
Be a Product Boss!
2022 • Design in Product 2022
Gold
Dave Gray
Connection, Community, and the Future of Work
2026 • Rosenfeld Community
Prayag Narula
Dialing for Research: How to Reach the Unreachable
2022 • Advancing Research 2022
Gold
Beth Chappell
Leading through ambiguity: Supporting a design team relearning their craft
2026 • Designing with AI 2026
Gold
Barb Spanton
Doing Work That Matters: A Look Beyond The Idealistic Notion of 'Doing Meaningful Work'
2022 • Design at Scale 2022
Gold

More Videos

Rachael Dietkus, LCSW

"Our ability to entice participants to share their most personal stories raises the potential to exploit them for design research."

Rachael Dietkus, LCSW

Trauma-Responsive Design: Reimagining the Future of Design Now

December 10, 2021

Robin Cannon

"Design systems haven't changed fundamentally; it’s just that AI removes the capacity to gloss over gaps with human judgment."

Robin Cannon

AI means your design system can't suck anymore

September 9, 2026

Gina Mendolia

"In large complex systems, the dots are scattered across silos and time zones, making progress feel elusive."

Gina Mendolia

Therapists, Coaches, and Grandmas: Techniques for Service Design in Complex Systems

December 3, 2024

Sam Proulx

"Using assistive technology is a skill and muscle memory built over years."

Sam Proulx

Understanding Screen Readers on Mobile: How And Why to Learn from Native Users

October 2, 2023

Bria Alexander

"If you’re not in our Slack channel, you’re missing out on so many big parts of the party."

Bria Alexander

Opening Remarks

September 29, 2021

Stephen Pollard

"Can we just hang out, get on the tube, and hang out at Heathrow? He looked at me very strangely."

Stephen Pollard

Closing Keynote: Getting giants to dance - what can we learn from designing large and complex public infrastructure?

November 7, 2017

Cheryl Platz

"Multimodal design adds a layer of orchestration on top of modality-specific designs like voice or graphical UI."

Cheryl Platz

Demystifying Multimodal Design: The Design Practice You Didn't Know You're Doing

April 4, 2024

Sam Proulx

"Screen magnification is really about making the screen larger, changing color contrast, reducing motion, and panning around the magnified area."

Sam Proulx

Prototype Reviews, People With Disabilities, and You

October 1, 2021

Dominique Ward

"If you extinguish 365 fires in a year, bravo, but what do you really have to show for it, and what’s next?"

Dominique Ward

The Most Exciting Time for DesignOps is Now

September 8, 2022