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
Sarah Alvarado
How to make UX research leadership more effective [Advancing Research Community Workshop Series]
2023 • Advancing Research Community
Emily Eagle
Can't Rewind: Radio and Retail
2019 • Enterprise Experience 2019
Gold
Zariah Cameron
ReDesigning Wellbeing for Equitable Care in the Workplace
2024 • DesignOps Summit 2024
Gold
Francesca Barrientos, PhD
You Need Your Own Definition of Design Maturity
2022 • Design at Scale 2022
Gold
Victor Udoewa
Radical Participatory Design: Decolonizing Participatory Design Processes
2021 • Civic Design 2021
Gold
Katie Johnson
Disrupting generative AI products with just-in-time consumer insights
2024 • Designing with AI 2024
Gold
Dorelle Rabinowitz
The Magic Word is Trust
2018 • Enterprise Experience 2018
Gold
Adel Du Toit
Get Your CFO To Say: 'Our Strategic Goal is User Obsession'
2022 • Design at Scale 2022
Gold
Sam Ladner
Data Exhaust and Personal Data: Learning from Consumer Products to Enhance Enterprise UX
2016 • Enterprise UX 2016
Gold
Melissa Tsang
From Insights to Action: Driving Business Values through DesignOps
2024 • DesignOps Summit 2020
Gold
Jemma Ahmed
Theme 1 Intro
2026 • Advancing Research 2026
Gold
Phil Hesketh
Designing Accessible Research Workflows
2021 • DesignOps Summit 2021
Gold
Alla Weinberg
Cross-Functional Relationship Design
2022 • Design in Product 2022
Gold
Sheri Byrne-Haber
The Importance of Accessible Design Systems
2024 • DesignOps Summit 2020
Gold
Prabhas Pokharel
Order and Chaos: New Ways of Collaborating on Synthesis and Storytelling
2022 • Advancing Research 2022
Gold
Aditi Ruiz
Pulse Check: Empathy Mapping Your Product Manager, Pt. 2
2022 • Design in Product 2022
Gold

More Videos

Greg Petroff

"The way we build software now is fundamentally different; it's just easier to write code using platforms and microservices."

Greg Petroff

Everything is About to Change: Software as Material

June 8, 2016

Michael Polivka

"Design is frequently misunderstood; sometimes it’s just about explaining why it’s important to get others involved."

Michael Polivka

Scaling Design through Relationship Maps

November 7, 2017

Bryce Benton

"OpenAI’s custom GPTs allow adding files and instructions, making AI a real partner in documentation and governance."

Bryce Benton

[Demo] AI-powered UX enhancement: Aligning GitHub documentation with USWDS at Austin Public Library

June 4, 2024

Dave Hoffer

"If you don’t have any work, make some spec work just to show your skills."

Dave Hoffer Joanne Weaver

UX Job Search AMA #2 with Joanne Weaver and Dave Hoffer

April 3, 2025

Jim Kalbach

"People don’t want a quarter inch drill, they want a quarter inch hole."

Jim Kalbach

Jobs To Be Done

February 25, 2021

Bassel Deeb

"You ask yourself, does this activity directly impact the quality, feature, price, or customer experience?"

Bassel Deeb Will Osborn

Do More With Less: Equip and Lead Design Orgs Through Adversity

October 2, 2023

Sean McKay

"If you give up, we all give up."

Sean McKay

Coexisting with non-researchers: Practical strategies for a democratized research future

March 11, 2025

Alissa Briggs

"An experiment coach spends about 10 to 20 percent of their time helping the team change mindsets and actions."

Alissa Briggs

How to Coach Enterprise Experimentation

May 14, 2015

Amanda Kaleta-Kott

"I had to become my father’s vaccine angel navigating a digital experience that was harrowing even for me."

Amanda Kaleta-Kott Lea Martin, PhD

The Joys and Dilemmas of Conducting UX Research with Older Adults

March 11, 2022